|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IFilter
This interface defines filters that are used in record selection and group selection. As the name implies, they are used to select specified data.
Note: The modifications you make to a filter are saved only if you have used a
controller. Use the
GroupFilterController
and the
RecordFilterController
to modify the group formula and record formula respectively.
Method Summary | |
---|---|
java.lang.String |
computeText()
Returns a String representation of the field value that can be used in a
report formula. |
java.lang.String |
displayText(FieldDisplayNameType displayNameType,
java.util.Locale locale)
Returns a UI-friendly string representation of the filter. |
FilterType |
getFilterType()
Gets the type of this filter. |
java.lang.String |
getFreeEditingText()
Deprecated. please use getText() |
java.lang.String |
getName()
Returns the name of the filter. |
void |
setFilterType(FilterType filterType)
Sets the type of this filter. |
void |
setFreeEditingText(java.lang.String freeEditingText)
Deprecated. please use setText(String) |
void |
setName(java.lang.String name)
Sets the name of the filter. |
Methods inherited from interface com.crystaldecisions.sdk.occa.report.data.IFormula |
---|
getFormulaNullTreatment, getSyntax, getText, setFormulaNullTreatment, setSyntax, setText |
Method Detail |
---|
java.lang.String computeText()
Returns a String
representation of the field value that can be used in a
report formula. The string is not formatted or localized. The syntax will always be Crystal
syntax.
If the field contains a date, computeText
returns Date(x, x, x)
;
if it contains a date and time, computeText
returns
DateTime(x, x, x, x, x, x)
. However, when the date is 1900, 0, 1 (the Java
start date), computeText
returns Time(x, x, x)
. If you want to
set a field to a time value only (that is, with no date), you should set the date to 1900, 0,
1, so that computeText
will retrieve the correct information.
String
representation of the field value that can be used in a
report formula.java.lang.String displayText(FieldDisplayNameType displayNameType, java.util.Locale locale)
Returns a UI-friendly string representation of the filter. This method attempts to structure the filter formula as close to a localized phrase as possible. If you do not pass in a locale, it attempts to localize the string using the user's default locale.
If the field contains a date, displayText
returns a locale-specific Date
string; if it contains a date and time, displayText
returns a locale-specific
DateTime string; if it contains a time string, displayText
returns a
locale-specific Time string.
displayNameType
- Indicates how the name of the field is displayed.locale
- Localizes the string according to a specific locale.
FilterType getFilterType()
FilterType
of this filterjava.lang.String getFreeEditingText()
String
containing the formula text that was originally used to
define the filter.java.lang.String getName()
String
containing the name of the filter.void setFilterType(FilterType filterType)
filterType
- a FilterType
void setFreeEditingText(java.lang.String freeEditingText)
freeEditingText
- A String
containing the formula text that was
originally used to define the filter.void setName(java.lang.String name)
name
- A String
containing the name of the filter.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |