|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.birt.report.model.api.ElementDetailHandle
org.eclipse.birt.report.model.api.ValueHandle
org.eclipse.birt.report.model.api.StructureHandle
org.eclipse.birt.report.model.api.StyleRuleHandle
org.eclipse.birt.report.model.api.HighlightRuleHandle
public class HighlightRuleHandle
Represents a highlight rule in the highlight property of a style. A highlight rule gives a set of conditional style properties along with a condition for when to apply the properties. A highlight can be defined in either a shared style or a private style.
ColorHandle
,
DimensionHandle
,
FontHandle
,
HighlightRule
,
DesignChoiceConstants
Field Summary |
---|
Fields inherited from class org.eclipse.birt.report.model.api.StructureHandle |
---|
structRef |
Fields inherited from class org.eclipse.birt.report.model.api.ElementDetailHandle |
---|
elementHandle |
Constructor Summary | |
---|---|
HighlightRuleHandle(SimpleValueHandle valueHandle,
int index)
Constructs a highlight rule handle with the given SimpleValueHandle and the index of the highlight rule in
the highlight. |
Method Summary | |
---|---|
ColorHandle |
getBackgroundColor()
Returns a handle to work with the background color. |
ColorHandle |
getBorderBottomColor()
Returns a handle to work with the border bottom color. |
java.lang.String |
getBorderBottomStyle()
Returns the style of the border bottom line. |
DimensionHandle |
getBorderBottomWidth()
Returns a handle to work with the width of the bottom side of the border. |
ColorHandle |
getBorderLeftColor()
Returns a handle to work with the border left color. |
java.lang.String |
getBorderLeftStyle()
Returns the style of the border left line. |
DimensionHandle |
getBorderLeftWidth()
Returns a handle to work with the width of the left side of the border. |
ColorHandle |
getBorderRightColor()
Returns a handle to work with the border right color. |
java.lang.String |
getBorderRightStyle()
Returns the style of the border right line. |
DimensionHandle |
getBorderRightWidth()
Returns a handle to work with the width of the right side of the border. |
ColorHandle |
getBorderTopColor()
Returns a handle to work with the border top color. |
java.lang.String |
getBorderTopStyle()
Returns the style of the top line of the border. |
DimensionHandle |
getBorderTopWidth()
Returns a handle to work with the width of the top side of the border. |
ColorHandle |
getColor()
Returns a handle to work with the color property. |
java.lang.String |
getDateTimeFormat()
Returns the pattern of the date-time-format for a highlight rule. |
java.lang.String |
getDateTimeFormatCategory()
Returns the category of the date-time-format for a highlight rule. |
FontHandle |
getFontFamilyHandle()
Returns the font family handle of the highlight rule. |
DimensionHandle |
getFontSize()
Returns a handle to work with the font size. |
java.lang.String |
getFontStyle()
Returns the font style handle for the style. |
java.lang.String |
getFontVariant()
Returns the font variant in a string. |
java.lang.String |
getFontWeight()
Returns the font weight of the highlight rule. |
java.lang.String |
getNumberAlign()
Returns the value of the number-align member. |
java.lang.String |
getNumberFormat()
Returns the pattern of a number format for a highlight rule. |
java.lang.String |
getNumberFormatCategory()
Returns the category of a number format for a highlight rule. |
java.lang.String |
getStringFormat()
Returns the pattern of a string format for a highlight rule. |
java.lang.String |
getStringFormatCategory()
Returns the category of a string format for a highlight rule. |
StyleHandle |
getStyle()
Returns the style that the highlight rule links with. |
java.lang.String |
getTestExpression()
gets the expression for this highlight rule. |
java.lang.String |
getTextAlign()
Returns the value of text align property. |
java.lang.String |
getTextDirection()
Returns the value of Bidi direction property. |
DimensionHandle |
getTextIndent()
Gets a handle to deal with the value of the text-indent property. |
java.lang.String |
getTextLineThrough()
Returns the value of the line through property. |
java.lang.String |
getTextOverline()
Returns the value of the overline property. |
java.lang.String |
getTextTransform()
Returns the value of the text transform property. |
java.lang.String |
getTextUnderline()
Returns the value of the underline property. |
void |
setBorderBottomStyle(java.lang.String value)
Sets the style of the border bottom line. |
void |
setBorderLeftStyle(java.lang.String value)
Sets the style of the border left line. |
void |
setBorderRightStyle(java.lang.String value)
Sets the style of the border right line. |
void |
setBorderTopStyle(java.lang.String value)
Sets the style of the top line of the border. |
void |
setDateTimeFormat(java.lang.String pattern)
Sets the pattern of a date time format for a highlight rule. |
void |
setDateTimeFormatCategory(java.lang.String pattern)
Sets the category of a number format for a highlight rule. |
void |
setFontStyle(java.lang.String value)
Sets the font style in a string for the style. |
void |
setFontVariant(java.lang.String value)
Sets the font variant in a string . |
void |
setFontWeight(java.lang.String value)
Sets the font weight in a string for the style. |
void |
setNumberAlign(java.lang.String value)
Sets the value of the number-align member |
void |
setNumberFormat(java.lang.String pattern)
Sets the pattern of a number format for a highlight rule. |
void |
setNumberFormatCategory(java.lang.String category)
Sets the category of a number format for a highlight rule. |
void |
setStringFormat(java.lang.String pattern)
Sets the pattern of a string format for a highlight rule. |
void |
setStringFormatCategory(java.lang.String category)
Sets the category of a string format for a highlight rule. |
void |
setStyle(StyleHandle style)
Sets the style property. |
void |
setStyleName(java.lang.String styleName)
Sets the style property. |
void |
setTestExpression(java.lang.String expression)
sets the test expression for this hilghtlight rule. |
void |
setTextAlign(java.lang.String value)
Sets the text align property. |
void |
setTextDirection(java.lang.String value)
Sets the Bidi direction property. |
void |
setTextLineThrough(java.lang.String value)
Sets the text line through property. |
void |
setTextOverline(java.lang.String value)
Sets the text overline property. |
void |
setTextTransform(java.lang.String value)
Sets the text transform property. |
void |
setTextUnderline(java.lang.String value)
Sets the text underline property. |
Methods inherited from class org.eclipse.birt.report.model.api.StyleRuleHandle |
---|
getOperator, getValue1, getValue1List, getValue2, setOperator, setValue1, setValue1, setValue2 |
Methods inherited from class org.eclipse.birt.report.model.api.StructureHandle |
---|
drop, getDefn, getExternalizedValue, getMember, getProperty, getPropertyDefn, getReference, getStringProperty, getStructure, isDesignTime, iterator, setDesignTime, setProperty, setPropertySilently |
Methods inherited from class org.eclipse.birt.report.model.api.ElementDetailHandle |
---|
getDesign, getElement, getElementHandle, getModule |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public HighlightRuleHandle(SimpleValueHandle valueHandle, int index)
SimpleValueHandle
and the index of the highlight rule in
the highlight.
valueHandle
- handle to a list property or memberindex
- index of the structure within the listMethod Detail |
---|
public ColorHandle getColor()
public ColorHandle getBackgroundColor()
public ColorHandle getBorderTopColor()
public ColorHandle getBorderLeftColor()
public ColorHandle getBorderRightColor()
public ColorHandle getBorderBottomColor()
public java.lang.String getBorderBottomStyle()
DesignChoiceConstants
.
They are:
LINE_STYLE_NONE
LINE_STYLE_SOLID
LINE_STYLE_DOTTED
LINE_STYLE_DASHED
LINE_STYLE_DOUBLE
LINE_STYLE_GROOVE
LINE_STYLE_RIDGE
LINE_STYLE_INSET
LINE_STYLE_OUTSET
public void setBorderBottomStyle(java.lang.String value) throws SemanticException
DesignChoiceConstants
.
value
- the new border bottom line style
SemanticException
- if the value is not one of above.getBorderBottomStyle( )
public java.lang.String getBorderLeftStyle()
getBorderBottomStyle( )
public void setBorderLeftStyle(java.lang.String value) throws SemanticException
value
- the new border left line style
SemanticException
- if the value is not one of above.setBorderBottomStyle( String )
public java.lang.String getBorderRightStyle()
getBorderBottomStyle( )
public void setBorderRightStyle(java.lang.String value) throws SemanticException
value
- the new border right line style
SemanticException
- if the value is not one of above.setBorderBottomStyle( String )
public java.lang.String getBorderTopStyle()
getBorderBottomStyle( )
public void setBorderTopStyle(java.lang.String value) throws SemanticException
value
- the new border top line style
SemanticException
- if the value is not one of above.setBorderBottomStyle( String )
public java.lang.String getTestExpression()
public void setTestExpression(java.lang.String expression)
expression
- the expressionpublic java.lang.String getTextUnderline()
DesignChoiceConstants
and can be one of:
TEXT_UNDERLINE_NONE
TEXT_UNDERLINE_UNDERLINE
public void setTextUnderline(java.lang.String value) throws SemanticException
DesignChoiceConstants
and can be one of:
TEXT_UNDERLINE_NONE
TEXT_UNDERLINE_UNDERLINE
value
- the new text underline
SemanticException
- if the value is not one of the above.public java.lang.String getTextOverline()
DesignChoiceConstants
and can be one of:
TEXT_OVERLINE_NONE
TEXT_OVERLINE_OVERLINE
public void setTextOverline(java.lang.String value) throws SemanticException
DesignChoiceConstants
and can be one of:
TEXT_OVERLINE_NONE
TEXT_OVERLINE_OVERLINE
value
- the new text overline
SemanticException
- if the value is not one of the abovepublic java.lang.String getTextLineThrough()
DesignChoiceConstants
and can be one of:
TEXT_LINE_THROUGH_NONE
TEXT_LINE_THROUGH_LINE_THROUGH
public void setTextLineThrough(java.lang.String value) throws SemanticException
DesignChoiceConstants
and can be one of:
TEXT_LINE_THROUGH_NONE
TEXT_LINE_THROUGH_LINE_THROUGH
value
- the new text line through
SemanticException
- if the value is not one of the above.public java.lang.String getTextAlign()
DesignChoiceConstants
and can be one of:
TEXT_ALIGN_LEFT
TEXT_ALIGN_CENTER
TEXT_ALIGN_RIGHT
TEXT_ALIGN_JUSTIFY
public void setTextAlign(java.lang.String value) throws SemanticException
DesignChoiceConstants
and can be one of:
TEXT_ALIGN_LEFT
TEXT_ALIGN_CENTER
TEXT_ALIGN_RIGHT
TEXT_ALIGN_JUSTIFY
value
- the new text align value
SemanticException
- if the value is not one of the above.public java.lang.String getTextDirection()
DesignChoiceConstants
and can be one of:
BIDI_ORIENTATION_LTR
BIDI_ORIENTATION_RTL
public void setTextDirection(java.lang.String value) throws SemanticException
DesignChoiceConstants
and can be one of:
BIDI_ORIENTATION_LTR
BIDI_ORIENTATION_RTL
value
- the new direction value
SemanticException
- if the value is not one of the above.public java.lang.String getTextTransform()
DesignChoiceConstants
and can be one of:
TRANSFORM_CAPITALIZE
TRANSFORM_UPPERCASE
TRANSFORM_LOWERCASE
TRANSFORM_NONE
public void setTextTransform(java.lang.String value) throws SemanticException
DesignChoiceConstants
and can be one of:
TRANSFORM_CAPITALIZE
TRANSFORM_UPPERCASE
TRANSFORM_LOWERCASE
TRANSFORM_NONE
value
- the new text transform
SemanticException
- if the value is not one of the above.public DimensionHandle getTextIndent()
public java.lang.String getNumberAlign()
public void setNumberAlign(java.lang.String value)
value
- the new number-align value.public DimensionHandle getBorderTopWidth()
public DimensionHandle getBorderLeftWidth()
public DimensionHandle getBorderRightWidth()
public DimensionHandle getBorderBottomWidth()
public DimensionHandle getFontSize()
public FontHandle getFontFamilyHandle()
public java.lang.String getFontWeight()
DesignChoiceConstants
and can be one of:
FONT_WEIGHT_NORMAL
FONT_WEIGHT_BOLD
FONT_WEIGHT_BOLDER
FONT_WEIGHT_LIGHTER
FONT_WEIGHT_100
FONT_WEIGHT_200
FONT_WEIGHT_300
FONT_WEIGHT_400
FONT_WEIGHT_500
FONT_WEIGHT_600
FONT_WEIGHT_700
FONT_WEIGHT_800
FONT_WEIGHT_900
public void setFontWeight(java.lang.String value) throws SemanticException
DesignChoiceConstants
.
value
- the new font weight
SemanticException
- if the input value is not one of the abovegetFontWeight( )
public java.lang.String getFontVariant()
DesignChoiceConstants
and can be one of:
FONT_VARIANT_NORMAL
FONT_VARIANT_SMALL_CAPS
public void setFontVariant(java.lang.String value) throws SemanticException
DesignChoiceConstants
and can be one of:
FONT_VARIANT_NORMAL
FONT_VARIANT_SMALL_CAPS
value
- the new font variant.
SemanticException
- if the input value is not one of the abovepublic java.lang.String getFontStyle()
DesignChoiceConstants
and can be one of:
FONT_STYLE_NORMAL
FONT_STYLE_ITALIC
FONT_STYLE_OBLIQUE
public void setFontStyle(java.lang.String value) throws SemanticException
DesignChoiceConstants
and can be one of:
FONT_STYLE_NORMAL
FONT_STYLE_ITALIC
FONT_STYLE_OBLIQUE
value
- the new font style.
SemanticException
- if the input value is not one of the abovepublic java.lang.String getStringFormat()
public java.lang.String getStringFormatCategory()
public void setStringFormat(java.lang.String pattern)
pattern
- the pattern of a string formapublic void setStringFormatCategory(java.lang.String category) throws SemanticException
pattern
can be one of:
DesignChoiceConstants.STRING_FORMAT_TYPE_UNFORMATTED
DesignChoiceConstants.STRING_FORMAT_TYPE_UPPERCASE
DesignChoiceConstants.STRING_FORMAT_TYPE_LOWERCASE
DesignChoiceConstants.STRING_FORMAT_TYPE_CUSTOM
DesignChoiceConstants.STRING_FORMAT_TYPE_ZIP_CODE
DesignChoiceConstants.STRING_FORMAT_TYPE_ZIP_CODE_4
DesignChoiceConstants.STRING_FORMAT_TYPE_PHONE_NUMBER
DesignChoiceConstants.STRING_FORMAT_TYPE_SOCIAL_SECURITY_NUMBER
category
- the category of a string format
SemanticException
- if category
is not one of the above values.public java.lang.String getNumberFormat()
public java.lang.String getNumberFormatCategory()
public void setNumberFormat(java.lang.String pattern)
pattern
- the pattern of a number formatpublic void setNumberFormatCategory(java.lang.String category) throws SemanticException
pattern
can be one of:
DesignChoiceConstants.NUMBER_FORMAT_TYPE_UNFORMATTED
DesignChoiceConstants.NUMBER_FORMAT_TYPE_GENERAL_NUMBER
DesignChoiceConstants.NUMBER_FORMAT_TYPE_CURRENCY
DesignChoiceConstants.NUMBER_FORMAT_TYPE_FIXED
DesignChoiceConstants.NUMBER_FORMAT_TYPE_PERCENT
DesignChoiceConstants.NUMBER_FORMAT_TYPE_SCIENTIFIC
DesignChoiceConstants.NUMBER_FORMAT_TYPE_STANDARD
DesignChoiceConstants.NUMBER_FORMAT_TYPE_CUSTOM
category
- the category of a number format
SemanticException
- if category
is not one of the above values.public java.lang.String getDateTimeFormat()
public java.lang.String getDateTimeFormatCategory()
public void setDateTimeFormat(java.lang.String pattern)
pattern
- the pattern of a date time formatpublic void setDateTimeFormatCategory(java.lang.String pattern) throws SemanticException
pattern
can be one of:
DesignChoiceConstants.DATETIEM_FORMAT_TYPE_UNFORMATTED
DesignChoiceConstants.DATETIEM_FORMAT_TYPE_GENERAL_DATE
DesignChoiceConstants.DATETIEM_FORMAT_TYPE_LONG_DATE
DesignChoiceConstants.DATETIEM_FORMAT_TYPE_MUDIUM_DATE
DesignChoiceConstants.DATETIEM_FORMAT_TYPE_SHORT_DATE
DesignChoiceConstants.DATETIEM_FORMAT_TYPE_LONG_TIME
DesignChoiceConstants.DATETIEM_FORMAT_TYPE_MEDIUM_TIME
DesignChoiceConstants.DATETIEM_FORMAT_TYPE_SHORT_TIME
DesignChoiceConstants.DATETIEM_FORMAT_TYPE_CUSTOM
pattern
- the category of a date-time format
SemanticException
- if pattern
is not one of the above values.public void setStyle(StyleHandle style) throws SemanticException
style
- the style
SemanticException
public void setStyleName(java.lang.String styleName) throws SemanticException
styleName
- the style name
SemanticException
public StyleHandle getStyle()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |