| com.microstrategy.web.objects.FilterDetailsFormatting |
This interface governs filter detail formatting properties.
| Fields | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| public static final String | DELIMITER_STR | ||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| abstract int |
delimitersAroundMetadataObjectNames()
When to use delimiters around metadata object names.
| ||||||||||
| abstract int |
expandShortcutFilters()
When to expand shortcut filters.
| ||||||||||
| abstract int |
includeFormNamesInAQConditions()
Whether to include form names in attribute qualification conditions.
| ||||||||||
| abstract int |
logicalOperatorBetweenConditions()
When to display logical operators.
| ||||||||||
| abstract int |
newlineAttrName()
Whether there is a newline after the Attr name.
| ||||||||||
| abstract int |
newlineBetweenConditions()
When newlines are inserted between conditions.
| ||||||||||
| abstract int |
newlineBetweenElements()
Default is
FALSE. | ||||||||||
| abstract int |
operatorDisplay()
Describes how operators are displayed, i.e.
| ||||||||||
| abstract int |
parenthesesAroundConditions()
When parentheses are displayed around conditions.
| ||||||||||
| abstract void |
set(String key, String value)
Generic approach to setting a value corresponding to a key instead of using the specific setter method
| ||||||||||
| abstract void |
setDelimitersAroundMetadataObjectNames(int delimiterCondition)
Governs when to use delimiters around metadata object names.
| ||||||||||
| abstract void |
setExpandShortcutFilters(int mode)
Governs when to expand shortcut filters.
| ||||||||||
| abstract void |
setIncludeFormNamesInAttrQualificationConditions(int includeFormNames)
Governs whether to include form names in attribute qualification conditions.
| ||||||||||
| abstract void |
setLogicalOperatorBetweenConditions(int mode)
Governs when to display logical operators.
| ||||||||||
| abstract void |
setNewlineAttrName(int mode)
Governs whether there is a newline after the Attr name.
| ||||||||||
| abstract void |
setNewlineBetweenConditions(int mode)
Governs when newlines are inserted between conditions.
| ||||||||||
| abstract void |
setNewlineBetweenElements(int mode)
Governs whether there is a newline between elements.
| ||||||||||
| abstract void |
setOperatorDisplay(int mode)
Governs how operators are displayed, i.e.
| ||||||||||
| abstract void |
setParenthesesAroundConditions(int mode)
This governs usage of parentheses around conditions.
| ||||||||||
| abstract void |
setShowAttrNameForElementPrompts(int mode)
Whether to show Attr name for Attr element prompts
according to specified argument.
| ||||||||||
| abstract void |
setShowAttrNameForInList(int mode)
Whether to show Attr name for in list conditions
according to specified argument.
| ||||||||||
| abstract void |
setTrimElements(int mode)
Governs whether whitespaces are trimmed from elements.
| ||||||||||
| abstract int |
showAttrNameForElementPrompts()
Whether to show Attr element names for Attr element prompts.
| ||||||||||
| abstract int |
showAttrNameForInList()
Whether to show Attr names for list conditions.
| ||||||||||
| abstract int |
trimElements()
Whether whitespaces are trimmed from elements.
| ||||||||||
Always shown/applied. Value = 1.
Clears the formatting attribute. If this is a RWUnit,
then the actual format setting will be inherited from the
underlying document. If this is a document format,
it will be inherited from the project.
Condition is false. Value = 0.
Metadata object names are only delimited if the name contains special characters.
Shows both the name and expansion.
Display logical AND operators only. Value = 2.
Display logical OR operators only. Value = 3.
Newlines are inserted between conditions for different logical operator nodes only. Value = 2.
Operators are displayed with their names.
Operators are displayed using symbols.
Indicates parentheses are enclosed around conditions that are children of the same logical operator node only. Value = 2.
Never shown/applied. Value = 0.
Shown/applied once. Value = 1.
Item is repeated. Value = 2.
Condition true. Value = 1.
When to use delimiters around metadata object names.
When to expand shortcut filters.
TRUE, FALSE, MODE_EXPAND_SHORTCUT_FILTERS_SHOW_NAME_AND_EXPAND, CLEAR.
When to display logical operators.
When newlines are inserted between conditions.
Describes how operators are displayed, i.e. as symbols or names.
When parentheses are displayed around conditions.
Generic approach to setting a value corresponding to a key instead of using the specific setter method
| key | a name from the list enumerated on this interface |
|---|---|
| value | value corresponding to the key |
Governs when to use delimiters around metadata object names.
| delimiterCondition | options: NEVER, ALWAYS, MODE_DELIMITERS_AROUND_METADATA_OBJECT_NAMES_FOR_SPECIAL_CHARS_ONLY, CLEAR.
|
|---|
Governs when to expand shortcut filters.
| mode | options: TRUE, FALSE, MODE_EXPAND_SHORTCUT_FILTERS_SHOW_NAME_AND_EXPAND, CLEAR.
|
|---|
Governs when to display logical operators.
| mode | options: NEVER, ALWAYS, MODE_LOGICAL_OPERATOR_BETWEEN_CONDITIONS_AND_ONLY, MODE_LOGICAL_OPERATOR_BETWEEN_CONDITIONS_OR_ONLY, CLEAR.
|
|---|
Governs when newlines are inserted between conditions.
| mode | options: NEVER, ALWAYS, MODE_NEWLINE_BETWEEN_CONDITIONS_FOR_DIFFERENT_LOGICAL_OP_NODES_ONLY.
|
|---|
Governs how operators are displayed, i.e. as symbols or names.
| mode | options: MODE_OPERATOR_DISPLAY_SYMBOL, MODE_OPERATOR_DISPLAY_NAME, CLEAR.
|
|---|
This governs usage of parentheses around conditions.
| mode | options: NEVER, ALWAYS, MODE_PARENTHESES_AROUND_CONDITIONS_FOR_SAME_LOGICAL_OP_CHILDREN_ONLY.
|
|---|