org.eclipse.birt.report.model.api.elements.structures
Class HighlightRule
java.lang.Object
org.eclipse.birt.report.model.core.Structure
org.eclipse.birt.report.model.core.PropertyStructure
org.eclipse.birt.report.model.api.elements.structures.StyleRule
org.eclipse.birt.report.model.api.elements.structures.HighlightRule
- All Implemented Interfaces:
- java.lang.Cloneable, org.eclipse.birt.report.model.core.IPropertySet, IStructure
- public class HighlightRule
- extends StyleRule
Represents a highlight rule that says how a data item should appear based on
the value within it. All highlight rules are driven by a value expression
defined on the style. Each rule has an expression that matches a set of
values, and a set of font and border instructions for how to format the data
item when the rule "fires."
Fields inherited from class org.eclipse.birt.report.model.core.PropertyStructure |
propValues |
Constructor Summary |
HighlightRule()
Default Constructor. |
HighlightRule(java.lang.String op,
java.lang.String v1,
java.lang.String v2,
java.lang.String testExpre)
Constructs the highlight rule with an operator and its arguments. |
Methods inherited from class org.eclipse.birt.report.model.core.PropertyStructure |
clone, getLocalProperty, getLocalProperty, setProperty |
Methods inherited from class org.eclipse.birt.report.model.core.Structure |
copy, equals, getHandle, getHandle, getObjectDefn, getProperty, getProperty, getReferencableProperty, isReferencable, setProperty, validate |
Methods inherited from class java.lang.Object |
finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
BORDER_TOP_STYLE_MEMBER
public static final java.lang.String BORDER_TOP_STYLE_MEMBER
- See Also:
- Constant Field Values
BORDER_TOP_WIDTH_MEMBER
public static final java.lang.String BORDER_TOP_WIDTH_MEMBER
- See Also:
- Constant Field Values
BORDER_TOP_COLOR_MEMBER
public static final java.lang.String BORDER_TOP_COLOR_MEMBER
- See Also:
- Constant Field Values
BORDER_LEFT_STYLE_MEMBER
public static final java.lang.String BORDER_LEFT_STYLE_MEMBER
- See Also:
- Constant Field Values
BORDER_LEFT_WIDTH_MEMBER
public static final java.lang.String BORDER_LEFT_WIDTH_MEMBER
- See Also:
- Constant Field Values
BORDER_LEFT_COLOR_MEMBER
public static final java.lang.String BORDER_LEFT_COLOR_MEMBER
- See Also:
- Constant Field Values
BORDER_BOTTOM_STYLE_MEMBER
public static final java.lang.String BORDER_BOTTOM_STYLE_MEMBER
- See Also:
- Constant Field Values
BORDER_BOTTOM_WIDTH_MEMBER
public static final java.lang.String BORDER_BOTTOM_WIDTH_MEMBER
- See Also:
- Constant Field Values
BORDER_BOTTOM_COLOR_MEMBER
public static final java.lang.String BORDER_BOTTOM_COLOR_MEMBER
- See Also:
- Constant Field Values
BORDER_RIGHT_STYLE_MEMBER
public static final java.lang.String BORDER_RIGHT_STYLE_MEMBER
- See Also:
- Constant Field Values
BORDER_RIGHT_WIDTH_MEMBER
public static final java.lang.String BORDER_RIGHT_WIDTH_MEMBER
- See Also:
- Constant Field Values
BORDER_RIGHT_COLOR_MEMBER
public static final java.lang.String BORDER_RIGHT_COLOR_MEMBER
- See Also:
- Constant Field Values
BACKGROUND_COLOR_MEMBER
public static final java.lang.String BACKGROUND_COLOR_MEMBER
- See Also:
- Constant Field Values
DATE_TIME_FORMAT_MEMBER
public static final java.lang.String DATE_TIME_FORMAT_MEMBER
- See Also:
- Constant Field Values
NUMBER_FORMAT_MEMBER
public static final java.lang.String NUMBER_FORMAT_MEMBER
- See Also:
- Constant Field Values
NUMBER_ALIGN_MEMBER
public static final java.lang.String NUMBER_ALIGN_MEMBER
- See Also:
- Constant Field Values
STRING_FORMAT_MEMBER
public static final java.lang.String STRING_FORMAT_MEMBER
- See Also:
- Constant Field Values
FONT_FAMILY_MEMBER
public static final java.lang.String FONT_FAMILY_MEMBER
- See Also:
- Constant Field Values
FONT_SIZE_MEMBER
public static final java.lang.String FONT_SIZE_MEMBER
- See Also:
- Constant Field Values
FONT_STYLE_MEMBER
public static final java.lang.String FONT_STYLE_MEMBER
- See Also:
- Constant Field Values
FONT_WEIGHT_MEMBER
public static final java.lang.String FONT_WEIGHT_MEMBER
- See Also:
- Constant Field Values
FONT_VARIANT_MEMBER
public static final java.lang.String FONT_VARIANT_MEMBER
- See Also:
- Constant Field Values
COLOR_MEMBER
public static final java.lang.String COLOR_MEMBER
- See Also:
- Constant Field Values
TEXT_UNDERLINE_MEMBER
public static final java.lang.String TEXT_UNDERLINE_MEMBER
- See Also:
- Constant Field Values
TEXT_OVERLINE_MEMBER
public static final java.lang.String TEXT_OVERLINE_MEMBER
- See Also:
- Constant Field Values
TEXT_LINE_THROUGH_MEMBER
public static final java.lang.String TEXT_LINE_THROUGH_MEMBER
- See Also:
- Constant Field Values
TEXT_ALIGN_MEMBER
public static final java.lang.String TEXT_ALIGN_MEMBER
- See Also:
- Constant Field Values
TEXT_TRANSFORM_MEMBER
public static final java.lang.String TEXT_TRANSFORM_MEMBER
- See Also:
- Constant Field Values
TEXT_INDENT_MEMBER
public static final java.lang.String TEXT_INDENT_MEMBER
- See Also:
- Constant Field Values
STRUCTURE_NAME
public static final java.lang.String STRUCTURE_NAME
- Name of this structure within the meta-data dictionary.
- See Also:
- Constant Field Values
HighlightRule
public HighlightRule()
- Default Constructor.
HighlightRule
public HighlightRule(java.lang.String op,
java.lang.String v1,
java.lang.String v2,
java.lang.String testExpre)
- Constructs the highlight rule with an operator and its arguments.
- Parameters:
op
- the supported operator. One of the internal choice values
identified in the meta-data dictionaryv1
- the comparison value expressions for operators that take one
or two arguments (equals, like, between)v2
- the second comparison value for operators that take two
arguments (between)testExpre
- the expression to check
getStructName
public java.lang.String getStructName()
- Description copied from interface:
IStructure
- Returns the name of the structure definition. The name is the one used to
define the structure in the meta-data dictionary.
- Returns:
- the internal name of the structure a defined in the meta-data
dictionary.
getDefn
public IStructureDefn getDefn()
- Description copied from interface:
IStructure
- Returns the structure definition from the meta-data dictionary.
handle
public StructureHandle handle(SimpleValueHandle valueHandle,
int index)
Copyright © 2005 Actuate Corp. All rights reserved.