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
,Serializable
,Cloneable
- Direct Known Subclasses:
AbstractValueElement
,JavaBean
,Subreport
,TextPart
The abstract class
AbstractFontElement
implements
FontProperties
class and extends Element
. Inherit
from this class to support Element
s that receive Font properties.- Since:
- 6.0
- See Also:
-
Nested Class Summary
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
Modifier and TypeMethodDescriptionint
Returns the value of the property 'font color'.Returns the formula for the property 'font color'.Returns the value of the property 'font name'.Returns the formula for the property 'font name'.int
Returns the value of the property 'font size', rounded to an integer(!).Returns the formula for the property 'font size'.int
Returns the value of the property 'font size' in Twips.int
Returns the value of the property 'font style'.Returns the formula for the property 'font style'.Returns a list with all property formulas that are set for this report element.Returns The formula field for the property 'strike out'.Returns the formula field for the property 'underline'.boolean
isBold()
Returns whether the text in this element is bold or not.boolean
isItalic()
Returns whether the text in this element is italic or not.boolean
Returns whether the text in this element is struck through or not.boolean
Returns whether the text in this element is underlined or not.parseElement
(com.inet.report.parser.XMLTag group, String tag, Attributes atts, Map<String, Object> parserMap) FOR INTERNAL USE ONLY FOR INTERNAL USE ONLY FOR INTERNAL USE ONLY Internal method for reading report XMLvoid
setBold
(boolean newValue) Sets the value of the property 'font bold'.void
setFontColor
(int newValue) Sets the value of the property 'font color'.void
setFontColorFormula
(FormulaField newFormula) Sets the formula of the property 'font color'.final void
setFontName
(String newValue) Sets the value of the property 'font name'.final void
setFontNameFormula
(FormulaField newFormula) Sets the formula for the property 'font name'.final void
setFontSize
(int newValue) Sets the value of the property 'font size'.final void
setFontSizeFormula
(FormulaField newFormula) Sets the formula for the property 'font size'.void
setFontSizeTwips
(int newValue) Sets the value of the property 'font size'.final void
setFontStyle
(int fontStyle) Sets the value of the property 'font style'.final void
setFontStyleFormula
(FormulaField newFormula) Sets the formula for the property 'font style'.final void
setItalic
(boolean newValue) Sets the value of the property 'italic'.final void
setStrikeout
(boolean newValue) Sets the value of the property 'strike out'.final void
setStrikeoutFormula
(FormulaField newFormula) Set the formula field for the property 'strike out'.final void
setUnderline
(boolean newValue) Sets the value of the property 'underline'.final void
setUnderlineFormula
(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 Details
-
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:
setFontSize
in interfaceFontProperties
- Parameters:
newValue
- The font size in points, e.g. 8.- Throws:
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:
getFontSize
in 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
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:
setFontSizeFormula
in interfaceFontProperties
- Parameters:
newFormula
- The new formula for the property 'font size'.- Since:
- 6.0
-
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:
getFontSizeFormula
in interfaceFontProperties
- Returns:
FormulaField
The formula for the property 'font size'.- Since:
- 6.0
- See Also:
-
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:
getFontName
in interfaceFontProperties
- Returns:
- The value of the property 'font name'.
- Since:
- 6.0
-
setFontName
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:
setFontName
in interfaceFontProperties
- Parameters:
newValue
- The new value of the property 'font name'.- Since:
- 6.0
-
setFontNameFormula
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:
setFontNameFormula
in interfaceFontProperties
- Parameters:
newFormula
- The formula for the property 'font name'.- Since:
- 6.0
-
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:
getFontNameFormula
in interfaceFontProperties
- Returns:
FormulaField
The 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:
getFontStyle
in 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:
-
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:
setFontStyle
in 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:
-
setFontStyleFormula
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:
setFontStyleFormula
in 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
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:
getFontStyleFormula
in interfaceFontProperties
- Returns:
FormulaField
The 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:
setItalic
in interfaceFontProperties
- Parameters:
newValue
- true if the property should be set, elsefalse
- Since:
- 6.0
- See Also:
-
isItalic
public boolean isItalic()Returns whether the text in this element is italic or not.- Specified by:
isItalic
in interfaceFontProperties
- Returns:
true
if the text is italic,false
otherwise.- Since:
- 7.0
- See Also:
-
isUnderline
public boolean isUnderline()Returns whether the text in this element is underlined or not.- Specified by:
isUnderline
in interfaceFontProperties
- Returns:
true
if the text is underlined,false
otherwise.- Since:
- 7.0
- See Also:
-
getUnderlineFormula
Returns the formula field for the property 'underline'.- Specified by:
getUnderlineFormula
in 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:
isStrikeout
in interfaceFontProperties
- Returns:
true
if the text is struck through,false
otherwise.- Since:
- 7.0
- See Also:
-
getStrikeoutFormula
Returns The formula field for the property 'strike out'.- Specified by:
getStrikeoutFormula
in 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:
setUnderline
in interfaceFontProperties
- Parameters:
newValue
- true if the property should be set, elsefalse
- Since:
- 6.0
- See Also:
-
setUnderlineFormula
Sets the formula field for the property 'underline'.- Specified by:
setUnderlineFormula
in 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:
setStrikeout
in interfaceFontProperties
- Parameters:
newValue
- true if the property should be set, elsefalse
- Since:
- 6.0
- See Also:
-
setStrikeoutFormula
Set the formula field for the property 'strike out'.- Specified by:
setStrikeoutFormula
in 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:
isBold
in interfaceFontProperties
- Returns:
true
if the text is bold,false
otherwise.- Since:
- 7.0
- See Also:
-
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:
setBold
in 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:
-
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:
setFontColor
in interfaceFontProperties
- Parameters:
newValue
- The new value of the property 'font color'.- Since:
- 6.0
-
setFontColorFormula
Sets the formula of the property 'font color'. Use this property to change the color of the font.- Specified by:
setFontColorFormula
in 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:
getFontColor
in interfaceFontProperties
- Returns:
- The value of the property 'font color'.
- Since:
- 6.0
-
getFontColorFormula
Returns the formula for the property 'font color'. Use this property to change the color of the font.- Specified by:
getFontColorFormula
in interfaceFontProperties
- Returns:
FormulaField
The 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:
setFontSizeTwips
in interfaceFontProperties
- Parameters:
newValue
- The font size in Twips.- Throws:
IllegalArgumentException
- if newValue is negative- Since:
- 6.0
-
getFontSizeTwips
public int getFontSizeTwips()Returns the value of the property 'font size' in Twips.- Specified by:
getFontSizeTwips
in interfaceFontProperties
- Returns:
- The font size in Twips.
- Since:
- 6.0
-
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 descendantReportComponent
of this one. To get the property formulas for descendantReportComponent
useReportComponent.getSubComponents()
- Overrides:
getPropertyFormulas
in classElement
- Returns:
- List of property formulas
-
parseElement
public NodeParser parseElement(com.inet.report.parser.XMLTag group, String tag, Attributes atts, Map<String, Object> parserMap) throws FatalParserExceptionFOR 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:
parseElement
in interfaceNodeParser
- Overrides:
parseElement
in 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.
-