Class HighlightRuleHandle
- java.lang.Object
-
- org.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 extends StyleRuleHandle
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.- See Also:
ColorHandle,DimensionHandle,FontHandle,HighlightRule,DesignChoiceConstants
-
-
Field Summary
-
Fields inherited from class org.eclipse.birt.report.model.api.StructureHandle
structContext
-
Fields inherited from class org.eclipse.birt.report.model.api.ElementDetailHandle
elementHandle
-
-
Constructor Summary
Constructors Constructor Description HighlightRuleHandle(SimpleValueHandle valueHandle, int index)Constructs a highlight rule handle with the givenSimpleValueHandleand the index of the highlight rule in the highlight.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ColorHandlegetBackgroundColor()Returns a handle to work with the background color.ColorHandlegetBorderBottomColor()Returns a handle to work with the border bottom color.java.lang.StringgetBorderBottomStyle()Returns the style of the border bottom line.DimensionHandlegetBorderBottomWidth()Returns a handle to work with the width of the bottom side of the border.ColorHandlegetBorderLeftColor()Returns a handle to work with the border left color.java.lang.StringgetBorderLeftStyle()Returns the style of the border left line.DimensionHandlegetBorderLeftWidth()Returns a handle to work with the width of the left side of the border.ColorHandlegetBorderRightColor()Returns a handle to work with the border right color.java.lang.StringgetBorderRightStyle()Returns the style of the border right line.DimensionHandlegetBorderRightWidth()Returns a handle to work with the width of the right side of the border.ColorHandlegetBorderTopColor()Returns a handle to work with the border top color.java.lang.StringgetBorderTopStyle()Returns the style of the top line of the border.DimensionHandlegetBorderTopWidth()Returns a handle to work with the width of the top side of the border.ColorHandlegetColor()Returns a handle to work with the color property.java.lang.StringgetDateTimeFormat()Returns the pattern of the date-time-format for a highlight rule.java.lang.StringgetDateTimeFormatCategory()Returns the category of the date-time-format for a highlight rule.FontHandlegetFontFamilyHandle()Returns the font family handle of the highlight rule.DimensionHandlegetFontSize()Returns a handle to work with the font size.java.lang.StringgetFontStyle()Returns the font style handle for the style.java.lang.StringgetFontVariant()Returns the font variant in a string.java.lang.StringgetFontWeight()Returns the font weight of the highlight rule.DimensionHandlegetLineHeight()Returns a handle to work with the height of the line.java.lang.StringgetNumberAlign()Returns the value of the number-align member.java.lang.StringgetNumberFormat()Returns the pattern of a number format for a highlight rule.java.lang.StringgetNumberFormatCategory()Returns the category of a number format for a highlight rule.java.lang.StringgetStringFormat()Returns the pattern of a string format for a highlight rule.java.lang.StringgetStringFormatCategory()Returns the category of a string format for a highlight rule.StyleHandlegetStyle()Returns the style that the highlight rule links with.java.lang.StringgetTestExpression()gets the expression for this highlight rule.java.lang.StringgetTextAlign()Returns the value of text align property.java.lang.StringgetTextDirection()Returns the value of Bidi direction property.DimensionHandlegetTextIndent()Gets a handle to deal with the value of the text-indent property.java.lang.StringgetTextLineThrough()Returns the value of the line through property.java.lang.StringgetTextOverline()Returns the value of the overline property.java.lang.StringgetTextTransform()Returns the value of the text transform property.java.lang.StringgetTextUnderline()Returns the value of the underline property.voidsetBorderBottomStyle(java.lang.String value)Sets the style of the border bottom line.voidsetBorderLeftStyle(java.lang.String value)Sets the style of the border left line.voidsetBorderRightStyle(java.lang.String value)Sets the style of the border right line.voidsetBorderTopStyle(java.lang.String value)Sets the style of the top line of the border.voidsetDateTimeFormat(java.lang.String pattern)Sets the pattern of a date time format for a highlight rule.voidsetDateTimeFormatCategory(java.lang.String pattern)Sets the category of a number format for a highlight rule.voidsetFontStyle(java.lang.String value)Sets the font style in a string for the style.voidsetFontVariant(java.lang.String value)Sets the font variant in a string .voidsetFontWeight(java.lang.String value)Sets the font weight in a string for the style.voidsetNumberAlign(java.lang.String value)Sets the value of the number-align membervoidsetNumberFormat(java.lang.String pattern)Sets the pattern of a number format for a highlight rule.voidsetNumberFormatCategory(java.lang.String category)Sets the category of a number format for a highlight rule.voidsetStringFormat(java.lang.String pattern)Sets the pattern of a string format for a highlight rule.voidsetStringFormatCategory(java.lang.String category)Sets the category of a string format for a highlight rule.voidsetStyle(StyleHandle style)Sets the style property.voidsetStyleName(java.lang.String styleName)Sets the style property.voidsetTestExpression(java.lang.String expression)sets the test expression for this hilghtlight rule.voidsetTextAlign(java.lang.String value)Sets the text align property.voidsetTextDirection(java.lang.String value)Sets the Bidi direction property.voidsetTextLineThrough(java.lang.String value)Sets the text line through property.voidsetTextOverline(java.lang.String value)Sets the text overline property.voidsetTextTransform(java.lang.String value)Sets the text transform property.voidsetTextUnderline(java.lang.String value)Sets the text underline property.-
Methods inherited from class org.eclipse.birt.report.model.api.StyleRuleHandle
getOperator, getValue1, getValue1ExpressionList, getValue1List, getValue2, setOperator, setValue1, setValue1, setValue2
-
Methods inherited from class org.eclipse.birt.report.model.api.StructureHandle
drop, getContext, getDefn, getExpressionProperty, getExternalizedValue, getExternalizedValue, getIntProperty, getMember, getProperty, getPropertyDefn, getStringProperty, getStructure, isDesignTime, isLocal, iterator, setDesignTime, setExpressionProperty, setProperty, setPropertySilently
-
Methods inherited from class org.eclipse.birt.report.model.api.ValueHandle
getReference
-
Methods inherited from class org.eclipse.birt.report.model.api.ElementDetailHandle
getDesign, getElement, getElementHandle, getModule
-
-
-
-
Constructor Detail
-
HighlightRuleHandle
public HighlightRuleHandle(SimpleValueHandle valueHandle, int index)
Constructs a highlight rule handle with the givenSimpleValueHandleand the index of the highlight rule in the highlight.- Parameters:
valueHandle- handle to a list property or memberindex- index of the structure within the list
-
-
Method Detail
-
getColor
public ColorHandle getColor()
Returns a handle to work with the color property.- Returns:
- a ColorHandle to deal with the color.
-
getBackgroundColor
public ColorHandle getBackgroundColor()
Returns a handle to work with the background color.- Returns:
- a ColorHandle to deal with the background color.
-
getBorderTopColor
public ColorHandle getBorderTopColor()
Returns a handle to work with the border top color.- Returns:
- a ColorHandle to deal with the border top color.
-
getBorderLeftColor
public ColorHandle getBorderLeftColor()
Returns a handle to work with the border left color.- Returns:
- a ColorHandle to deal with the border left color.
-
getBorderRightColor
public ColorHandle getBorderRightColor()
Returns a handle to work with the border right color.- Returns:
- a ColorHandle to deal with the border right color.
-
getBorderBottomColor
public ColorHandle getBorderBottomColor()
Returns a handle to work with the border bottom color.- Returns:
- a ColorHandle to deal with the border bottom color.
-
getBorderBottomStyle
public java.lang.String getBorderBottomStyle()
Returns the style of the border bottom line. The return value is one of the CSS (pre-defined) values seeDesignChoiceConstants. They are:LINE_STYLE_NONELINE_STYLE_SOLIDLINE_STYLE_DOTTEDLINE_STYLE_DASHEDLINE_STYLE_DOUBLELINE_STYLE_GROOVELINE_STYLE_RIDGELINE_STYLE_INSETLINE_STYLE_OUTSET
- Returns:
- the border bottom style
-
setBorderBottomStyle
public void setBorderBottomStyle(java.lang.String value) throws SemanticExceptionSets the style of the border bottom line. The input value is one of the CSS (pre-defined) values seeDesignChoiceConstants.- Parameters:
value- the new border bottom line style- Throws:
SemanticException- if the value is not one of above.- See Also:
getBorderBottomStyle()
-
getBorderLeftStyle
public java.lang.String getBorderLeftStyle()
Returns the style of the border left line.- Returns:
- the border left line style
- See Also:
getBorderBottomStyle()
-
setBorderLeftStyle
public void setBorderLeftStyle(java.lang.String value) throws SemanticExceptionSets the style of the border left line.- Parameters:
value- the new border left line style- Throws:
SemanticException- if the value is not one of above.- See Also:
setBorderBottomStyle(String )
-
getBorderRightStyle
public java.lang.String getBorderRightStyle()
Returns the style of the border right line.- Returns:
- the border right line style
- See Also:
getBorderBottomStyle()
-
setBorderRightStyle
public void setBorderRightStyle(java.lang.String value) throws SemanticExceptionSets the style of the border right line.- Parameters:
value- the new border right line style- Throws:
SemanticException- if the value is not one of above.- See Also:
setBorderBottomStyle(String )
-
getBorderTopStyle
public java.lang.String getBorderTopStyle()
Returns the style of the top line of the border.- Returns:
- the border top line style
- See Also:
getBorderBottomStyle()
-
setBorderTopStyle
public void setBorderTopStyle(java.lang.String value) throws SemanticExceptionSets the style of the top line of the border.- Parameters:
value- the new border top line style- Throws:
SemanticException- if the value is not one of above.- See Also:
setBorderBottomStyle(String )
-
getTestExpression
public java.lang.String getTestExpression()
gets the expression for this highlight rule.- Returns:
- the expression value
-
setTestExpression
public void setTestExpression(java.lang.String expression)
sets the test expression for this hilghtlight rule.- Parameters:
expression- the expression
-
getTextUnderline
public java.lang.String getTextUnderline()
Returns the value of the underline property. The returned value is defined inDesignChoiceConstantsand can be one of:TEXT_UNDERLINE_NONETEXT_UNDERLINE_UNDERLINE
- Returns:
- the value of the underline property
-
setTextUnderline
public void setTextUnderline(java.lang.String value) throws SemanticExceptionSets the text underline property. The input value is defined inDesignChoiceConstantsand can be one of:TEXT_UNDERLINE_NONETEXT_UNDERLINE_UNDERLINE
- Parameters:
value- the new text underline- Throws:
SemanticException- if the value is not one of the above.
-
getTextOverline
public java.lang.String getTextOverline()
Returns the value of the overline property. The returned value is defined inDesignChoiceConstantsand can be one of:TEXT_OVERLINE_NONETEXT_OVERLINE_OVERLINE
- Returns:
- the value of the overline property
-
setTextOverline
public void setTextOverline(java.lang.String value) throws SemanticExceptionSets the text overline property. The input value is defined inDesignChoiceConstantsand can be one of:TEXT_OVERLINE_NONETEXT_OVERLINE_OVERLINE
- Parameters:
value- the new text overline- Throws:
SemanticException- if the value is not one of the above
-
getTextLineThrough
public java.lang.String getTextLineThrough()
Returns the value of the line through property. The returned value is defined inDesignChoiceConstantsand can be one of:TEXT_LINE_THROUGH_NONETEXT_LINE_THROUGH_LINE_THROUGH
- Returns:
- the text line through
-
setTextLineThrough
public void setTextLineThrough(java.lang.String value) throws SemanticExceptionSets the text line through property. The input value is defined inDesignChoiceConstantsand can be one of:TEXT_LINE_THROUGH_NONETEXT_LINE_THROUGH_LINE_THROUGH
- Parameters:
value- the new text line through- Throws:
SemanticException- if the value is not one of the above.
-
getTextAlign
public java.lang.String getTextAlign()
Returns the value of text align property. The return value is defined inDesignChoiceConstantsand can be one of:TEXT_ALIGN_LEFTTEXT_ALIGN_CENTERTEXT_ALIGN_RIGHTTEXT_ALIGN_JUSTIFY
- Returns:
- the value of text align property
-
setTextAlign
public void setTextAlign(java.lang.String value) throws SemanticExceptionSets the text align property. The input value is defined inDesignChoiceConstantsand can be one of:TEXT_ALIGN_LEFTTEXT_ALIGN_CENTERTEXT_ALIGN_RIGHTTEXT_ALIGN_JUSTIFY
- Parameters:
value- the new text align value- Throws:
SemanticException- if the value is not one of the above.
-
getTextDirection
public java.lang.String getTextDirection()
Returns the value of Bidi direction property. The return value is defined inDesignChoiceConstantsand can be one of:BIDI_ORIENTATION_LTRBIDI_ORIENTATION_RTL
- Returns:
- the value of Bidi direction property
-
setTextDirection
public void setTextDirection(java.lang.String value) throws SemanticExceptionSets the Bidi direction property. The input value is defined inDesignChoiceConstantsand can be one of:BIDI_ORIENTATION_LTRBIDI_ORIENTATION_RTL
- Parameters:
value- the new direction value- Throws:
SemanticException- if the value is not one of the above.
-
getTextTransform
public java.lang.String getTextTransform()
Returns the value of the text transform property. The return value is defined inDesignChoiceConstantsand can be one of:TRANSFORM_CAPITALIZETRANSFORM_UPPERCASETRANSFORM_LOWERCASETRANSFORM_NONE
- Returns:
- the value of the transform property
-
setTextTransform
public void setTextTransform(java.lang.String value) throws SemanticExceptionSets the text transform property. The input value is defined inDesignChoiceConstantsand can be one of:TRANSFORM_CAPITALIZETRANSFORM_UPPERCASETRANSFORM_LOWERCASETRANSFORM_NONE
- Parameters:
value- the new text transform- Throws:
SemanticException- if the value is not one of the above.
-
getTextIndent
public DimensionHandle getTextIndent()
Gets a handle to deal with the value of the text-indent property.- Returns:
- a DimensionHandle to deal with the text-indent.
-
getNumberAlign
public java.lang.String getNumberAlign()
Returns the value of the number-align member.- Returns:
- the number-align value
-
setNumberAlign
public void setNumberAlign(java.lang.String value)
Sets the value of the number-align member- Parameters:
value- the new number-align value.
-
getBorderTopWidth
public DimensionHandle getBorderTopWidth()
Returns a handle to work with the width of the top side of the border.- Returns:
- a DimensionHandle to deal with the width of the top side of the border.
-
getBorderLeftWidth
public DimensionHandle getBorderLeftWidth()
Returns a handle to work with the width of the left side of the border.- Returns:
- a DimensionHandle to deal with the width of the left side of the border.
-
getBorderRightWidth
public DimensionHandle getBorderRightWidth()
Returns a handle to work with the width of the right side of the border.- Returns:
- DimensionHandle to deal with the width of the right side of the border.
-
getBorderBottomWidth
public DimensionHandle getBorderBottomWidth()
Returns a handle to work with the width of the bottom side of the border.- Returns:
- a DimensionHandle to deal with the width of the bottom side of the border.
-
getFontSize
public DimensionHandle getFontSize()
Returns a handle to work with the font size.- Returns:
- a aDimensionHandle to deal with the font size.
-
getFontFamilyHandle
public FontHandle getFontFamilyHandle()
Returns the font family handle of the highlight rule.- Returns:
- the font family handle of the highlight rule.
-
getFontWeight
public java.lang.String getFontWeight()
Returns the font weight of the highlight rule. The return value is defined inDesignChoiceConstantsand can be one of:FONT_WEIGHT_NORMALFONT_WEIGHT_BOLDFONT_WEIGHT_BOLDERFONT_WEIGHT_LIGHTERFONT_WEIGHT_100FONT_WEIGHT_200FONT_WEIGHT_300FONT_WEIGHT_400FONT_WEIGHT_500FONT_WEIGHT_600FONT_WEIGHT_700FONT_WEIGHT_800FONT_WEIGHT_900
- Returns:
- the font weight in string.
-
setFontWeight
public void setFontWeight(java.lang.String value) throws SemanticExceptionSets the font weight in a string for the style. The input value is defined inDesignChoiceConstants.- Parameters:
value- the new font weight- Throws:
SemanticException- if the input value is not one of the above- See Also:
getFontWeight()
-
getFontVariant
public java.lang.String getFontVariant()
Returns the font variant in a string. The return value is defined inDesignChoiceConstantsand can be one of:FONT_VARIANT_NORMALFONT_VARIANT_SMALL_CAPS
- Returns:
- the font variant in a string.
-
setFontVariant
public void setFontVariant(java.lang.String value) throws SemanticExceptionSets the font variant in a string . The input value is defined inDesignChoiceConstantsand can be one of:FONT_VARIANT_NORMALFONT_VARIANT_SMALL_CAPS
- Parameters:
value- the new font variant.- Throws:
SemanticException- if the input value is not one of the above
-
getFontStyle
public java.lang.String getFontStyle()
Returns the font style handle for the style. The return value is defined inDesignChoiceConstantsand can be one of:FONT_STYLE_NORMALFONT_STYLE_ITALICFONT_STYLE_OBLIQUE
- Returns:
- the font style in string.
-
setFontStyle
public void setFontStyle(java.lang.String value) throws SemanticExceptionSets the font style in a string for the style. The input value is defined inDesignChoiceConstantsand can be one of:FONT_STYLE_NORMALFONT_STYLE_ITALICFONT_STYLE_OBLIQUE
- Parameters:
value- the new font style.- Throws:
SemanticException- if the input value is not one of the above
-
getStringFormat
public java.lang.String getStringFormat()
Returns the pattern of a string format for a highlight rule.- Returns:
- the pattern of a string format
-
getStringFormatCategory
public java.lang.String getStringFormatCategory()
Returns the category of a string format for a highlight rule.- Returns:
- the category of a string forma
-
setStringFormat
public void setStringFormat(java.lang.String pattern)
Sets the pattern of a string format for a highlight rule.- Parameters:
pattern- the pattern of a string forma
-
setStringFormatCategory
public void setStringFormatCategory(java.lang.String category) throws SemanticExceptionSets the category of a string format for a highlight rule. Thepatterncan be one of:DesignChoiceConstants.STRING_FORMAT_TYPE_UNFORMATTEDDesignChoiceConstants.STRING_FORMAT_TYPE_UPPERCASEDesignChoiceConstants.STRING_FORMAT_TYPE_LOWERCASEDesignChoiceConstants.STRING_FORMAT_TYPE_CUSTOMDesignChoiceConstants.STRING_FORMAT_TYPE_ZIP_CODEDesignChoiceConstants.STRING_FORMAT_TYPE_ZIP_CODE_4DesignChoiceConstants.STRING_FORMAT_TYPE_PHONE_NUMBER-
DesignChoiceConstants.STRING_FORMAT_TYPE_SOCIAL_SECURITY_NUMBER
- Parameters:
category- the category of a string format- Throws:
SemanticException- ifcategoryis not one of the above values.
-
getNumberFormat
public java.lang.String getNumberFormat()
Returns the pattern of a number format for a highlight rule.- Returns:
- the pattern of a number format
-
getNumberFormatCategory
public java.lang.String getNumberFormatCategory()
Returns the category of a number format for a highlight rule.- Returns:
- the category of a number format
-
setNumberFormat
public void setNumberFormat(java.lang.String pattern)
Sets the pattern of a number format for a highlight rule.- Parameters:
pattern- the pattern of a number format
-
setNumberFormatCategory
public void setNumberFormatCategory(java.lang.String category) throws SemanticExceptionSets the category of a number format for a highlight rule. Thepatterncan be one of:DesignChoiceConstants.NUMBER_FORMAT_TYPE_UNFORMATTEDDesignChoiceConstants.NUMBER_FORMAT_TYPE_GENERAL_NUMBERDesignChoiceConstants.NUMBER_FORMAT_TYPE_CURRENCYDesignChoiceConstants.NUMBER_FORMAT_TYPE_FIXEDDesignChoiceConstants.NUMBER_FORMAT_TYPE_PERCENTDesignChoiceConstants.NUMBER_FORMAT_TYPE_SCIENTIFICDesignChoiceConstants.NUMBER_FORMAT_TYPE_STANDARDDesignChoiceConstants.NUMBER_FORMAT_TYPE_CUSTOM
- Parameters:
category- the category of a number format- Throws:
SemanticException- ifcategoryis not one of the above values.
-
getDateTimeFormat
public java.lang.String getDateTimeFormat()
Returns the pattern of the date-time-format for a highlight rule.- Returns:
- the pattern of the date-time-format
-
getDateTimeFormatCategory
public java.lang.String getDateTimeFormatCategory()
Returns the category of the date-time-format for a highlight rule.- Returns:
- the category of the date-time-format
-
setDateTimeFormat
public void setDateTimeFormat(java.lang.String pattern)
Sets the pattern of a date time format for a highlight rule.- Parameters:
pattern- the pattern of a date time format
-
setDateTimeFormatCategory
public void setDateTimeFormatCategory(java.lang.String pattern) throws SemanticExceptionSets the category of a number format for a highlight rule. Thepatterncan be one of:DesignChoiceConstants.DATETIEM_FORMAT_TYPE_UNFORMATTEDDesignChoiceConstants.DATETIEM_FORMAT_TYPE_GENERAL_DATEDesignChoiceConstants.DATETIEM_FORMAT_TYPE_LONG_DATEDesignChoiceConstants.DATETIEM_FORMAT_TYPE_MUDIUM_DATEDesignChoiceConstants.DATETIEM_FORMAT_TYPE_SHORT_DATEDesignChoiceConstants.DATETIEM_FORMAT_TYPE_LONG_TIMEDesignChoiceConstants.DATETIEM_FORMAT_TYPE_MEDIUM_TIMEDesignChoiceConstants.DATETIEM_FORMAT_TYPE_SHORT_TIMEDesignChoiceConstants.DATETIEM_FORMAT_TYPE_CUSTOM
- Parameters:
pattern- the category of a date-time format- Throws:
SemanticException- ifpatternis not one of the above values.
-
setStyle
public void setStyle(StyleHandle style) throws SemanticException
Sets the style property. If it is a valid style and highlight rule has no local values, values on the style are returned.- Parameters:
style- the style- Throws:
SemanticException
-
setStyleName
public void setStyleName(java.lang.String styleName) throws SemanticExceptionSets the style property. If it is a valid style and highlight rule has no local values, values on the style are returned.- Parameters:
styleName- the style name- Throws:
SemanticException
-
getStyle
public StyleHandle getStyle()
Returns the style that the highlight rule links with.- Returns:
- the style
-
getLineHeight
public DimensionHandle getLineHeight()
Returns a handle to work with the height of the line.- Returns:
- a DimensionHandle to deal with the height o f the line.
-
-