|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.pentaho.reporting.engine.classic.core.Element
org.pentaho.reporting.engine.classic.core.TextElement
public class TextElement
The base class for all elements that display text in a report band.
All content is converted to String using the String.valueOf () method. To convert values in a more sophisicated way, add filters to this element. Known filters are for instance theNumberFormatFilter
or the
SimpleDateFormatFilter
.
For more information on filters have a look at the filter package org.pentaho.reporting.engine.classic.core.filter
Field Summary | |
---|---|
static String |
CONTENT_TYPE
Deprecated. No longer used. |
Fields inherited from class org.pentaho.reporting.engine.classic.core.Element |
---|
ANONYMOUS_ELEMENT_PREFIX |
Constructor Summary | |
---|---|
TextElement()
Deprecated. Creates a new empty text element. |
Method Summary | |
---|---|
Object |
clone()
Deprecated. Clones this element. |
Element |
derive(boolean preserveElementInstanceIds)
Deprecated. Creates a deep copy of this element and regenerates all instance-ids. |
FontDefinition |
getFont()
Deprecated. Retrieve the required font properties directly from the stylesheet. |
String |
getFontName()
Deprecated. Returns the name of the current font. |
int |
getFontSize()
Deprecated. Returns the font size in points. |
float |
getLineHeight()
Deprecated. Returns the lineheight for the element. |
String |
getNullString()
Deprecated. Return the null-value representation for this element. |
String |
getReservedLiteral()
Deprecated. Returns the reserved literal for this text element. |
Object |
getValue(ExpressionRuntime runtime)
Deprecated. Returns the value for this text element. |
boolean |
isBold()
Deprecated. Checks whether the font should be displayed in bold style. |
boolean |
isItalic()
Deprecated. Checks whether the font should be displayed in italic style. |
boolean |
isStrikethrough()
Deprecated. Returns whether the text should have the strikethough style applied. |
boolean |
isUnderline()
Deprecated. Returns whether the text should be displayed underlined. |
void |
setBold(boolean bold)
Deprecated. Defines, whether the font should be displayed in bold, false otherwise. |
void |
setFont(FontDefinition font)
Deprecated. Set the required font properties directly on the stylesheet. |
void |
setFontName(String fontName)
Deprecated. Defines the font name of the current font. |
void |
setFontSize(int fontSize)
Deprecated. Defines the height of the font in points. |
void |
setItalic(boolean italic)
Deprecated. Defines, whether the font should be displayed in italics. |
void |
setLineHeight(float lineHeight)
Deprecated. Defines the lineheight for the element. |
void |
setNullString(String s)
Deprecated. Defines the null value representation for this element. |
void |
setReservedLiteral(String reservedLiteral)
Deprecated. Defines the reserved literal for this text element. |
void |
setStrikethrough(boolean strikethrough)
Deprecated. Defines, whether the text should be displayed striked through. |
void |
setUnderline(boolean underline)
Deprecated. Defines, whether the text should be displayed with the underline style applied. |
String |
toString()
Deprecated. Returns a string representation of this element, useful for debugging purposes. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final String CONTENT_TYPE
Constructor Detail |
---|
public TextElement()
Method Detail |
---|
public String getNullString()
setNullString(String)
public void setNullString(String s)
s
- the null string.public final Object getValue(ExpressionRuntime runtime)
StringFilter
is used to ensure that the final result is an instance of String (even
though it is returned as an Object.
getValue
in class Element
runtime
- the expression runtime for evaluating inline expression.
public String toString()
toString
in class Element
public Object clone() throws CloneNotSupportedException
clone
in interface DataTarget
clone
in class Element
CloneNotSupportedException
- this should never happen.public Element derive(boolean preserveElementInstanceIds) throws CloneNotSupportedException
Element
derive
in class Element
preserveElementInstanceIds
- defines whether this call generates new instance-ids for the derived elements.
Instance-IDs are used by the report processor to recognize reoccurring elements
and must not changed within the report run. Outside of the report processors
new instance ids should be generated at all times to separate
instances and to make them uniquely identifiable.
CloneNotSupportedException
public String getFontName()
public void setFontName(String fontName)
fontName
- the font namepublic int getFontSize()
public void setFontSize(int fontSize)
fontSize
- the font size in points.public boolean isBold()
public void setBold(boolean bold)
bold
- true, if the font should be displayed in bold, false otherwisepublic boolean isItalic()
public void setItalic(boolean italic)
italic
- true, if the font should be in italic style, false otherwise.public boolean isUnderline()
public void setUnderline(boolean underline)
underline
- true, if the text should be displayed underlined, false otherwise.public boolean isStrikethrough()
public void setStrikethrough(boolean strikethrough)
strikethrough
- whether to display the text with strikethrough style appliedpublic FontDefinition getFont()
public void setFont(FontDefinition font)
font
- the font definition for this element.public float getLineHeight()
public void setLineHeight(float lineHeight)
lineHeight
- the defined line height.public String getReservedLiteral()
public void setReservedLiteral(String reservedLiteral)
reservedLiteral
- the reserved literal.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |