Package com.inet.report
Class AbstractFontElement
- java.lang.Object
-
- com.inet.report.ReportComponent
-
- com.inet.report.Element
-
- com.inet.report.AbstractFontElement
-
- All Implemented Interfaces:
FontProperties,GeneralProperties,NodeParser,com.inet.report.ReferenceHolder,java.io.Serializable,java.lang.Cloneable
- Direct Known Subclasses:
AbstractValueElement,JavaBean,Subreport,TextPart
public abstract class AbstractFontElement extends Element implements FontProperties
The abstract classAbstractFontElementimplementsFontPropertiesclass and extendsElement. Inherit from this class to supportElements that receive Font properties.- Since:
- 6.0
- See Also:
Element,FontProperties, Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classAbstractFontElement.FontPropsFOR INTERNAL USE ONLY-
Nested classes/interfaces inherited from class com.inet.report.Element
Element.BorderProps, Element.CommonProperties, Element.ElementTypes, Element.HyperlinkProps, Element.StringProps
-
-
Field Summary
-
Fields inherited from class com.inet.report.Element
BOX, CHART, CROSSTAB, CROSSTABSECTION, DATABASE_PICTURE, FIELD, FIELDPART, FORMFIELD, INTERACTIVE_SORTING, JAVABEAN, LINE, PARAGRAPH, PICTURE, SIGNATURE, SUBREPORT, TEXT, TEXTPART
-
Fields inherited from interface com.inet.report.FontProperties
FONT_DIALOG, FONT_MONOSPACED, FONT_SANS_SERIF, FONT_SERIF, FONT_STYLE_BOLD, FONT_STYLE_ITALIC, FONT_STYLE_STRIKETHROUGH, FONT_STYLE_UNDERLINE
-
Fields inherited from interface com.inet.report.GeneralProperties
ALIGN_HORIZONTAL_CENTER, ALIGN_HORIZONTAL_DEFAULT, ALIGN_HORIZONTAL_JUSTIFIED, ALIGN_HORIZONTAL_LEFT, ALIGN_HORIZONTAL_RIGHT
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description intgetFontColor()Returns the value of the property 'font color'.FormulaFieldgetFontColorFormula()Returns the formula for the property 'font color'.java.lang.StringgetFontName()Returns the value of the property 'font name'.FormulaFieldgetFontNameFormula()Returns the formula for the property 'font name'.intgetFontSize()Returns the value of the property 'font size', rounded to an integer(!).FormulaFieldgetFontSizeFormula()Returns the formula for the property 'font size'.intgetFontSizeTwips()Returns the value of the property 'font size' in Twips.intgetFontStyle()Returns the value of the property 'font style'.FormulaFieldgetFontStyleFormula()Returns the formula for the property 'font style'.java.util.List<FormulaField>getPropertyFormulas()Returns a list with all property formulas that are set for this report element.FormulaFieldgetStrikeoutFormula()Returns The formula field for the property 'strike out'.FormulaFieldgetUnderlineFormula()Returns the formula field for the property 'underline'.booleanisBold()Returns whether the text in this element is bold or not.booleanisItalic()Returns whether the text in this element is italic or not.booleanisStrikeout()Returns whether the text in this element is struck through or not.booleanisUnderline()Returns whether the text in this element is underlined or not.NodeParserparseElement(com.inet.report.parser.XMLTag group, java.lang.String tag, org.xml.sax.Attributes atts, java.util.Map<java.lang.String,java.lang.Object> parserMap)FOR INTERNAL USE ONLY FOR INTERNAL USE ONLY FOR INTERNAL USE ONLY Internal method for reading report XMLvoidsetBold(boolean newValue)Sets the value of the property 'font bold'.voidsetFontColor(int newValue)Sets the value of the property 'font color'.voidsetFontColorFormula(FormulaField newFormula)Sets the formula of the property 'font color'.voidsetFontName(java.lang.String newValue)Sets the value of the property 'font name'.voidsetFontNameFormula(FormulaField newFormula)Sets the formula for the property 'font name'.voidsetFontSize(int newValue)Sets the value of the property 'font size'.voidsetFontSizeFormula(FormulaField newFormula)Sets the formula for the property 'font size'.voidsetFontSizeTwips(int newValue)Sets the value of the property 'font size'.voidsetFontStyle(int fontStyle)Sets the value of the property 'font style'.voidsetFontStyleFormula(FormulaField newFormula)Sets the formula for the property 'font style'.voidsetItalic(boolean newValue)Sets the value of the property 'italic'.voidsetStrikeout(boolean newValue)Sets the value of the property 'strike out'.voidsetStrikeoutFormula(FormulaField newFormula)Set the formula field for the property 'strike out'.voidsetUnderline(boolean newValue)Sets the value of the property 'underline'.voidsetUnderlineFormula(FormulaField newFormula)Sets the formula field for the property 'underline'.-
Methods inherited from class com.inet.report.Element
addListener, copy, getBottomLineStyle, getBottomLineStyleFormula, getBulletValueStack, getCanGrowCount, getCanGrowFormula, getCloseBorderOnPageBreakFormula, getDropShadowFormula, getEngine, getField, getForeColor, getForeColorFormula, getHorAlign, getHorAlignFormula, getHyperlinkUrl, getHyperlinkUrlFormula, getLeftLineStyle, getLeftLineStyleFormula, getListStack, getParent, getRightLineStyle, getRightLineStyleFormula, getSuppressIfDuplicatedFormula, getTightHorizontalFormula, getToolTipsText, getToolTipsTextFormula, getTopLineStyle, getTopLineStyleFormula, getTypeAsString, indexOf, isCanGrow, isCloseBorderOnPageBreak, isCloseBorderOnPageBreakInternal, isDropShadow, isInCrossTab, isSuppressIfDuplicated, isTightHorizontal, paramString, parseText, removeListener, setBottomLineStyle, setBottomLineStyleFormula, setBulletValueStack, setCanGrow, setCanGrowCount, setCanGrowFormula, setCloseBorderOnPageBreak, setCloseBorderOnPageBreakFormula, setDropShadow, setDropShadowFormula, setField, setForeColor, setForeColorFormula, setHorAlign, setHorAlignFormula, setHyperlinkUrl, setHyperlinkUrlFormula, setIndex, setLeftLineStyle, setLeftLineStyleFormula, setListStack, setReferences, setRightLineStyle, setRightLineStyleFormula, setSuppressIfDuplicated, setSuppressIfDuplicatedFormula, setTightHorizontal, setTightHorizontalFormula, setToolTipsText, setToolTipsTextFormula, setTopLineStyle, setTopLineStyleFormula
-
Methods inherited from class com.inet.report.ReportComponent
addPropertyChangeListener, addPropertyChangeListener, addReferencedObject, addVetoableChangeListener, addVetoableChangeListener, getBackColor, getBackColorFormula, getCustomData, getHeight, getKeepTogetherFormula, getRealReferencedObjectCount, getReferencedObjectCount, getReferencedObjects, getSubComponents, getSuppressFormula, getType, getWidth, getX, getY, isDOMParser, isKeepTogether, isSuppress, parseDOM, parseEndElement, removePropertyChangeListener, removePropertyChangeListener, removeReferencedObject, removeVetoableChangeListener, removeVetoableChangeListener, resetReferences, setBackColor, setBackColorFormula, setCustomData, setHeight, setKeepTogether, setKeepTogetherFormula, setSuppress, setSuppressFormula, setWidth, setX, setY
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface com.inet.report.GeneralProperties
getKeepTogetherFormula, getSuppressFormula, isKeepTogether, isSuppress, setKeepTogether, setKeepTogetherFormula, setSuppress, setSuppressFormula
-
-
-
-
Method Detail
-
setFontSize
public final void setFontSize(int newValue)
Sets the value of the property 'font size'. Use this property to change the font format of the labels in this field element.- Specified by:
setFontSizein interfaceFontProperties- Parameters:
newValue- The font size in points, e.g. 8.- Throws:
java.lang.IllegalArgumentException- if newValue is negative- Since:
- 6.0
-
getFontSize
public int getFontSize()
Returns the value of the property 'font size', rounded to an integer(!). For full accuracy you will want to usegetFontSizeTwips()instead. Use this property to change the font format of the labels in this field element.- Specified by:
getFontSizein interfaceFontProperties- Returns:
- The font size in points, rounded to an integer. For full accuracy you will want to use
getFontSizeTwips()instead. - Since:
- 6.0
-
setFontSizeFormula
public final void setFontSizeFormula(FormulaField newFormula)
Sets the formula for the property 'font size'. Use this property to change the font format of the labels in this field element.- Specified by:
setFontSizeFormulain interfaceFontProperties- Parameters:
newFormula- The new formula for the property 'font size'.- Since:
- 6.0
-
getFontSizeFormula
public FormulaField getFontSizeFormula()
Returns the formula for the property 'font size'. Use this property to change the font format of the labels in this field element.- Specified by:
getFontSizeFormulain interfaceFontProperties- Returns:
FormulaFieldThe formula for the property 'font size'.- Since:
- 6.0
- See Also:
FormulaField
-
getFontName
public java.lang.String getFontName()
Returns the value of the property 'font name'. Use this property to change the name of the font, used by the labels in this field element.- Specified by:
getFontNamein interfaceFontProperties- Returns:
- The value of the property 'font name'.
- Since:
- 6.0
-
setFontName
public final void setFontName(java.lang.String newValue)
Sets the value of the property 'font name'. Use this property to change the name of the font, used by the labels in this field element.
The font name will be used when the font-mapping to symbolic fonts is switched off in the i-net Clear Reports configuration (see UseNativeFonts and FontPath= for PDF export)- Specified by:
setFontNamein interfaceFontProperties- Parameters:
newValue- The new value of the property 'font name'.- Since:
- 6.0
-
setFontNameFormula
public final void setFontNameFormula(FormulaField newFormula)
Sets the formula for the property 'font name'. Use this property to change the name of the font, used by the labels in this field element.- Specified by:
setFontNameFormulain interfaceFontProperties- Parameters:
newFormula- The formula for the property 'font name'.- Since:
- 6.0
-
getFontNameFormula
public FormulaField getFontNameFormula()
Returns the formula for the property 'font name'. Use this property to change the name of the font, used by the labels in this field element.- Specified by:
getFontNameFormulain interfaceFontProperties- Returns:
FormulaFieldThe formula for the property 'font name'.- Since:
- 6.0
-
getFontStyle
public int getFontStyle()
Returns the value of the property 'font style'. The 'font style' property represents the different styles of a font, which can be italic, underline and/or strike out.- Specified by:
getFontStylein interfaceFontProperties- Returns:
- The value of the property 'font style', where
italic is represented by second bit of newValue,
underline by the third bit of newValue,
strikeout by the fourth bit of newValue. - Since:
- 6.0
- See Also:
FontProperties.FONT_STYLE_BOLD,FontProperties.FONT_STYLE_ITALIC,FontProperties.FONT_STYLE_UNDERLINE,FontProperties.FONT_STYLE_STRIKETHROUGH
-
setFontStyle
public final void setFontStyle(int fontStyle)
Sets the value of the property 'font style'. The 'font style' property represents the different styles of a font, which can be cursive, underline and/or strike out.- Specified by:
setFontStylein interfaceFontProperties- Parameters:
fontStyle- The new font style, where
bold is represented by the first bit,
cursive is represented by the second bit,
underline by the third bit,
strikeout by the fourth bit.- Since:
- 6.0
- See Also:
FontProperties.FONT_STYLE_BOLD,FontProperties.FONT_STYLE_ITALIC,FontProperties.FONT_STYLE_UNDERLINE,FontProperties.FONT_STYLE_STRIKETHROUGH
-
setFontStyleFormula
public final void setFontStyleFormula(FormulaField newFormula)
Sets the formula for the property 'font style'. The 'font style' property represents the different styles of a font, which can be cursive, underline and/or strike out.- Specified by:
setFontStyleFormulain interfaceFontProperties- Parameters:
newFormula- The new formula for the property 'font style'. The result of the formula should be within the range from 0 to 15, where
bold is represented by the first bit,
cursive is represented by the second bit,
underline by the third bit,
strikeout by the fourth bit.- Since:
- 6.0
-
getFontStyleFormula
public FormulaField getFontStyleFormula()
Returns the formula for the property 'font style'. The 'font style' property represents the different styles of a font, which can be cursive, underline and/or strike out.- Specified by:
getFontStyleFormulain interfaceFontProperties- Returns:
FormulaFieldThe formula for the property 'font style'.- Since:
- 6.0
-
setItalic
public final void setItalic(boolean newValue)
Sets the value of the property 'italic'. Use this property to toggle the font style of a text.- Specified by:
setItalicin interfaceFontProperties- Parameters:
newValue- true if the property should be set, elsefalse- Since:
- 6.0
- See Also:
setFontStyleFormula(com.inet.report.FormulaField)
-
isItalic
public boolean isItalic()
Returns whether the text in this element is italic or not.- Specified by:
isItalicin interfaceFontProperties- Returns:
trueif the text is italic,falseotherwise.- Since:
- 7.0
- See Also:
FontProperties.setFontStyle(int)
-
isUnderline
public boolean isUnderline()
Returns whether the text in this element is underlined or not.- Specified by:
isUnderlinein interfaceFontProperties- Returns:
trueif the text is underlined,falseotherwise.- Since:
- 7.0
- See Also:
FontProperties.setFontStyle(int)
-
getUnderlineFormula
public FormulaField getUnderlineFormula()
Returns the formula field for the property 'underline'.- Specified by:
getUnderlineFormulain interfaceFontProperties- Returns:
- the formula field for the property 'underline'.
- Since:
- 6.0
-
isStrikeout
public boolean isStrikeout()
Returns whether the text in this element is struck through or not.- Specified by:
isStrikeoutin interfaceFontProperties- Returns:
trueif the text is struck through,falseotherwise.- Since:
- 7.0
- See Also:
FontProperties.setFontStyle(int)
-
getStrikeoutFormula
public FormulaField getStrikeoutFormula()
Returns The formula field for the property 'strike out'.- Specified by:
getStrikeoutFormulain interfaceFontProperties- Returns:
- The formula field for the property 'strike out'.
- Since:
- 6.0
-
setUnderline
public final void setUnderline(boolean newValue)
Sets the value of the property 'underline'. Use this property to underline a text.- Specified by:
setUnderlinein interfaceFontProperties- Parameters:
newValue- true if the property should be set, elsefalse- Since:
- 6.0
- See Also:
FontProperties.setFontStyle(int)
-
setUnderlineFormula
public final void setUnderlineFormula(FormulaField newFormula)
Sets the formula field for the property 'underline'.- Specified by:
setUnderlineFormulain interfaceFontProperties- Parameters:
newFormula- the formula field for the property 'underline'.- Since:
- 6.0
-
setStrikeout
public final void setStrikeout(boolean newValue)
Sets the value of the property 'strike out'. Use this property to strike out a text.- Specified by:
setStrikeoutin interfaceFontProperties- Parameters:
newValue- true if the property should be set, elsefalse- Since:
- 6.0
- See Also:
FontProperties.setFontStyle(int)
-
setStrikeoutFormula
public final void setStrikeoutFormula(FormulaField newFormula)
Set the formula field for the property 'strike out'.- Specified by:
setStrikeoutFormulain interfaceFontProperties- Parameters:
newFormula- The formula field for the property 'strike out'.- Since:
- 6.0
-
isBold
public boolean isBold()
Returns whether the text in this element is bold or not.- Specified by:
isBoldin interfaceFontProperties- Returns:
trueif the text is bold,falseotherwise.- Since:
- 7.0
- See Also:
FontProperties.setFontStyle(int)
-
setBold
public void setBold(boolean newValue)
Sets the value of the property 'font bold'. Use this property to toggle the font style of a text.- Specified by:
setBoldin interfaceFontProperties- Parameters:
newValue- Whether or not this font element is to be set as bold. Note that this property can be overridden if a property formula is defined.- Since:
- 6.0
- See Also:
setFontStyleFormula(com.inet.report.FormulaField)
-
setFontColor
public void setFontColor(int newValue)
Sets the value of the property 'font color'. Use this property to change the color of the font.- Specified by:
setFontColorin interfaceFontProperties- Parameters:
newValue- The new value of the property 'font color'.- Since:
- 6.0
-
setFontColorFormula
public void setFontColorFormula(FormulaField newFormula)
Sets the formula of the property 'font color'. Use this property to change the color of the font.- Specified by:
setFontColorFormulain interfaceFontProperties- Parameters:
newFormula- The new formula for the property 'font color'.- Since:
- 6.0
-
getFontColor
public int getFontColor()
Returns the value of the property 'font color'. Use this property to change the color of the font.- Specified by:
getFontColorin interfaceFontProperties- Returns:
- The value of the property 'font color'.
- Since:
- 6.0
-
getFontColorFormula
public FormulaField getFontColorFormula()
Returns the formula for the property 'font color'. Use this property to change the color of the font.- Specified by:
getFontColorFormulain interfaceFontProperties- Returns:
FormulaFieldThe formula for the property 'font color'.- Since:
- 6.0
-
setFontSizeTwips
public void setFontSizeTwips(int newValue)
Sets the value of the property 'font size'.- Specified by:
setFontSizeTwipsin interfaceFontProperties- Parameters:
newValue- The font size in Twips.- Throws:
java.lang.IllegalArgumentException- if newValue is negative- Since:
- 6.0
-
getFontSizeTwips
public int getFontSizeTwips()
Returns the value of the property 'font size' in Twips.- Specified by:
getFontSizeTwipsin interfaceFontProperties- Returns:
- The font size in Twips.
- Since:
- 6.0
-
getPropertyFormulas
public java.util.List<FormulaField> getPropertyFormulas()
Returns a list with all property formulas that are set for this report element. This includes property formulas for any type of sub-component but excludes formulas for any descendantReportComponentof this one. To get the property formulas for descendantReportComponentuseReportComponent.getSubComponents()- Overrides:
getPropertyFormulasin classElement- Returns:
- List of property formulas
-
parseElement
public NodeParser parseElement(com.inet.report.parser.XMLTag group, java.lang.String tag, org.xml.sax.Attributes atts, java.util.Map<java.lang.String,java.lang.Object> parserMap) throws FatalParserException
FOR INTERNAL USE ONLY FOR INTERNAL USE ONLY FOR INTERNAL USE ONLY Internal method for reading report XMLParses an XML node with the given information, and returns either a sub-element which was created as a result, or null if no sub-element was created, i.e. the information was applied to the ReportComponent itself. Note that the parsing is highly tolerant, i.e. exceptions are intercepted and suppressed if at all possible.
- Specified by:
parseElementin interfaceNodeParser- Overrides:
parseElementin classElement- Parameters:
group- XMLTag of the current node to be parsed, or null if there is no such current group. An XMLTag is a group of nodes bundled together, usually it is a Properties node such as CommonProperties, BorderProperties, etc.tag- The XMLTag to be parsedatts- The set of attributes in the current XMLTagparserMap- The map of current Parser.- Returns:
- The NodeParser sub-element if one needed to be created, or null if none was created.
- Throws:
FatalParserException- if an exception occurs which causes the report to not be able to be read: causes the abortion of the reading of the report.
-
-