|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object net.sf.jasperreports.engine.fill.JRTemplateElement net.sf.jasperreports.engine.fill.JRTemplateText
public class JRTemplateText
Text element information shared by multiple print text objects.
JRTemplatePrintText
,
Serialized FormField Summary | |
---|---|
protected java.lang.String |
fontName
|
protected java.lang.Integer |
fontSize
|
protected java.lang.String |
formatFactoryClass
|
protected java.lang.Boolean |
isBold
|
protected java.lang.Boolean |
isItalic
|
protected java.lang.Boolean |
isPdfEmbedded
|
protected java.lang.Boolean |
isStrikeThrough
|
protected java.lang.Boolean |
isUnderline
|
protected JRLineBox |
lineBox
|
protected java.lang.String |
localeCode
|
protected JRParagraph |
paragraph
|
protected java.lang.String |
pattern
|
protected java.lang.String |
pdfEncoding
|
protected java.lang.String |
pdfFontName
|
protected java.lang.String |
timeZoneId
|
protected java.lang.String |
valueClassName
|
Fields inherited from class net.sf.jasperreports.engine.fill.JRTemplateElement |
---|
defaultStyleProvider, origin, parentStyle |
Fields inherited from interface net.sf.jasperreports.engine.JRFont |
---|
DEFAULT_FONT_NAME, DEFAULT_FONT_SIZE, DEFAULT_PDF_EMBEDDED, DEFAULT_PDF_ENCODING, DEFAULT_PDF_FONT_NAME |
Fields inherited from interface net.sf.jasperreports.engine.JRCommonText |
---|
MARKUP_HTML, MARKUP_NONE, MARKUP_RTF, MARKUP_STYLED_TEXT |
Constructor Summary | |
---|---|
|
JRTemplateText(JROrigin origin,
JRDefaultStyleProvider defaultStyleProvider)
Creates a template text. |
protected |
JRTemplateText(JROrigin origin,
JRDefaultStyleProvider defaultStyleProvider,
JRStaticText staticText)
|
protected |
JRTemplateText(JROrigin origin,
JRDefaultStyleProvider defaultStyleProvider,
JRTextField textField)
|
Method Summary | |
---|---|
void |
copyLineBox(JRLineBox box)
Copies box attributes. |
void |
copyParagraph(JRParagraph prg)
Copies paragraph attributes. |
java.awt.Color |
getDefaultLineColor()
|
JRFont |
getFont()
Deprecated. |
java.lang.String |
getFontName()
|
int |
getFontSize()
|
java.lang.String |
getFormatFactoryClass()
|
int |
getHashCode()
Returns a hash code to be used for the deduplicate map. |
HorizontalAlignEnum |
getHorizontalAlignmentValue()
Gets the text horizontal alignment. |
byte |
getHyperlinkTarget()
Deprecated. |
HyperlinkTargetEnum |
getHyperlinkTargetValue()
Retrieves the hyperlink target name for the element. |
HyperlinkTypeEnum |
getHyperlinkTypeValue()
Retrieves the hyperlink type for the element. |
JRLineBox |
getLineBox()
|
LineSpacingEnum |
getLineSpacingValue()
Deprecated. Replaced by JRParagraph.getLineSpacing() . |
java.lang.String |
getLinkTarget()
Returns the hyperlink target name. |
java.lang.String |
getLinkType()
Returns the hyperlink type. |
java.lang.String |
getLocaleCode()
|
java.lang.String |
getMarkup()
Returns the text markup. |
ModeEnum |
getModeValue()
Returns the element transparency mode. |
java.lang.String |
getOwnFontName()
|
java.lang.Integer |
getOwnFontSize()
|
HorizontalAlignEnum |
getOwnHorizontalAlignmentValue()
|
LineSpacingEnum |
getOwnLineSpacingValue()
Deprecated. Replaced by JRParagraph.getOwnLineSpacing() . |
java.lang.String |
getOwnMarkup()
|
java.lang.String |
getOwnPdfEncoding()
|
java.lang.String |
getOwnPdfFontName()
|
RotationEnum |
getOwnRotationValue()
Gets the text own rotation. |
VerticalAlignEnum |
getOwnVerticalAlignmentValue()
|
JRParagraph |
getParagraph()
|
java.lang.String |
getPattern()
|
java.lang.String |
getPdfEncoding()
|
java.lang.String |
getPdfFontName()
|
RotationEnum |
getRotationValue()
Gets the text rotation. |
JRStyle |
getStyle()
Returns this object's style. |
java.lang.String |
getTimeZoneId()
|
java.lang.String |
getValueClassName()
|
VerticalAlignEnum |
getVerticalAlignmentValue()
Gets the text vertical alignment. |
boolean |
isBold()
|
boolean |
isIdentical(java.lang.Object object)
Determines if this instance is identical to another object. |
boolean |
isItalic()
|
java.lang.Boolean |
isOwnBold()
|
java.lang.Boolean |
isOwnItalic()
|
java.lang.Boolean |
isOwnPdfEmbedded()
|
java.lang.Boolean |
isOwnStrikeThrough()
|
java.lang.Boolean |
isOwnUnderline()
|
boolean |
isPdfEmbedded()
|
boolean |
isStrikeThrough()
|
boolean |
isUnderline()
|
void |
setBold(boolean isBold)
|
void |
setBold(java.lang.Boolean isBold)
Alternative setBold method which allows also to reset the "own" isBold property. |
void |
setFontName(java.lang.String fontName)
|
void |
setFontSize(int fontSize)
|
void |
setFontSize(java.lang.Integer fontSize)
Alternative setSize method which allows also to reset the "own" size property. |
void |
setFormatFactoryClass(java.lang.String formatFactoryClass)
|
void |
setHorizontalAlignment(HorizontalAlignEnum horizontalAlignmentValue)
Sets the text horizontal alignment. |
void |
setItalic(boolean isItalic)
|
void |
setItalic(java.lang.Boolean isItalic)
Alternative setItalic method which allows also to reset the "own" isItalic property. |
void |
setLineSpacing(LineSpacingEnum lineSpacing)
Deprecated. Replaced by JRParagraph.setLineSpacing(LineSpacingEnum) . |
protected void |
setLinkTarget(java.lang.String linkTarget)
|
void |
setLinkType(java.lang.String linkType)
Sets the hyperlink type. |
void |
setLocaleCode(java.lang.String localeCode)
|
void |
setMarkup(java.lang.String markup)
Sets the text markup attribute. |
void |
setPattern(java.lang.String pattern)
|
void |
setPdfEmbedded(boolean isPdfEmbedded)
|
void |
setPdfEmbedded(java.lang.Boolean isPdfEmbedded)
Alternative setPdfEmbedded method which allows also to reset the "own" isPdfEmbedded property. |
void |
setPdfEncoding(java.lang.String pdfEncoding)
|
void |
setPdfFontName(java.lang.String pdfFontName)
|
void |
setRotation(RotationEnum rotationValue)
Sets the text rotation. |
protected void |
setStaticText(JRStaticText staticText)
|
void |
setStrikeThrough(boolean isStrikeThrough)
|
void |
setStrikeThrough(java.lang.Boolean isStrikeThrough)
Alternative setStrikeThrough method which allows also to reset the "own" isStrikeThrough property. |
protected void |
setTextElement(JRTextElement textElement)
|
protected void |
setTextField(JRTextField textField)
|
void |
setTimeZoneId(java.lang.String timeZoneId)
|
void |
setUnderline(boolean isUnderline)
|
void |
setUnderline(java.lang.Boolean isUnderline)
Alternative setUnderline method which allows also to reset the "own" isUnderline property. |
void |
setValueClassName(java.lang.String valueClassName)
|
void |
setVerticalAlignment(VerticalAlignEnum verticalAlignmentValue)
Gets the text vertical alignment. |
Methods inherited from class net.sf.jasperreports.engine.fill.JRTemplateElement |
---|
addTemplateHash, getBackcolor, getBaseStyle, getDefaultStyleProvider, getForecolor, getHeight, getId, getKey, getOrigin, getOwnBackcolor, getOwnForecolor, getOwnModeValue, getParentProperties, getPropertiesMap, getStyleNameReference, getUUID, getWidth, hasProperties, setBackcolor, setElement, setForecolor, setKey, setMode, setStyle, templateIdentical |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface net.sf.jasperreports.engine.JRCommonElement |
---|
getBackcolor, getForecolor, getHeight, getKey, getOwnBackcolor, getOwnForecolor, getOwnModeValue, getWidth, setBackcolor, setForecolor, setMode |
Methods inherited from interface net.sf.jasperreports.engine.JRIdentifiable |
---|
getUUID |
Methods inherited from interface net.sf.jasperreports.engine.JRStyleContainer |
---|
getDefaultStyleProvider, getStyleNameReference |
Field Detail |
---|
protected JRLineBox lineBox
protected JRParagraph paragraph
protected java.lang.String fontName
protected java.lang.Boolean isBold
protected java.lang.Boolean isItalic
protected java.lang.Boolean isUnderline
protected java.lang.Boolean isStrikeThrough
protected java.lang.Integer fontSize
protected java.lang.String pdfFontName
protected java.lang.String pdfEncoding
protected java.lang.Boolean isPdfEmbedded
protected java.lang.String valueClassName
protected java.lang.String pattern
protected java.lang.String formatFactoryClass
protected java.lang.String localeCode
protected java.lang.String timeZoneId
Constructor Detail |
---|
protected JRTemplateText(JROrigin origin, JRDefaultStyleProvider defaultStyleProvider, JRStaticText staticText)
protected JRTemplateText(JROrigin origin, JRDefaultStyleProvider defaultStyleProvider, JRTextField textField)
public JRTemplateText(JROrigin origin, JRDefaultStyleProvider defaultStyleProvider)
origin
- the origin of the elements that will use this templatedefaultStyleProvider
- the default style provider to use for
this templateMethod Detail |
---|
protected void setStaticText(JRStaticText staticText)
protected void setTextField(JRTextField textField)
protected void setTextElement(JRTextElement textElement)
public void copyLineBox(JRLineBox box)
box
- the object to copy attributes frompublic void copyParagraph(JRParagraph prg)
prg
- the object to copy attributes frompublic ModeEnum getModeValue()
JRCommonElement
getModeValue
in interface JRCommonElement
getModeValue
in class JRTemplateElement
public HorizontalAlignEnum getHorizontalAlignmentValue()
JRAlignment
getHorizontalAlignmentValue
in interface JRAlignment
HorizontalAlignEnum
public HorizontalAlignEnum getOwnHorizontalAlignmentValue()
getOwnHorizontalAlignmentValue
in interface JRAlignment
public void setHorizontalAlignment(HorizontalAlignEnum horizontalAlignmentValue)
JRAlignment
setHorizontalAlignment
in interface JRAlignment
horizontalAlignmentValue
- a value representing one of the horizontal alignment constants in HorizontalAlignEnum
public VerticalAlignEnum getVerticalAlignmentValue()
JRAlignment
getVerticalAlignmentValue
in interface JRAlignment
VerticalAlignEnum
public VerticalAlignEnum getOwnVerticalAlignmentValue()
getOwnVerticalAlignmentValue
in interface JRAlignment
public void setVerticalAlignment(VerticalAlignEnum verticalAlignmentValue)
JRAlignment
setVerticalAlignment
in interface JRAlignment
verticalAlignmentValue
- a value representing one of the vertical alignment constants in VerticalAlignEnum
public RotationEnum getRotationValue()
JRCommonText
getRotationValue
in interface JRCommonText
RotationEnum
public RotationEnum getOwnRotationValue()
JRCommonText
getOwnRotationValue
in interface JRCommonText
RotationEnum
public void setRotation(RotationEnum rotationValue)
setRotation
in interface JRCommonText
rotationValue
- one of
values, or null
if this template
should not specify a rotation attribute of its ownpublic LineSpacingEnum getLineSpacingValue()
JRParagraph.getLineSpacing()
.
getLineSpacingValue
in interface JRCommonText
public LineSpacingEnum getOwnLineSpacingValue()
JRParagraph.getOwnLineSpacing()
.
getOwnLineSpacingValue
in interface JRCommonText
public void setLineSpacing(LineSpacingEnum lineSpacing)
JRParagraph.setLineSpacing(LineSpacingEnum)
.
setLineSpacing
in interface JRCommonText
public java.lang.String getMarkup()
JRCommonText
getMarkup
in interface JRCommonText
public java.lang.String getOwnMarkup()
getOwnMarkup
in interface JRCommonText
public void setMarkup(java.lang.String markup)
setMarkup
in interface JRCommonText
markup
- the markup attributegetMarkup()
public JRLineBox getLineBox()
getLineBox
in interface JRBoxContainer
public JRParagraph getParagraph()
getParagraph
in interface JRParagraphContainer
public JRFont getFont()
public HyperlinkTypeEnum getHyperlinkTypeValue()
The actual hyperlink type is determined by getLinkType()
.
This method can is used to determine whether the hyperlink type is one of the
built-in types or a custom type.
O * When hyperlink is of custom type, CUSTOM
is returned.
getLinkType()
public byte getHyperlinkTarget()
public HyperlinkTargetEnum getHyperlinkTargetValue()
The actual hyperlink target name is determined by getLinkTarget()
.
This method is used to determine whether the hyperlink target name is one of the
built-in names or a custom one.
When hyperlink target has a custom name, CUSTOM
is returned.
getLinkTarget()
public java.lang.String getFontName()
getFontName
in interface JRFont
public java.lang.String getOwnFontName()
getOwnFontName
in interface JRFont
public void setFontName(java.lang.String fontName)
setFontName
in interface JRFont
public boolean isBold()
isBold
in interface JRFont
public java.lang.Boolean isOwnBold()
isOwnBold
in interface JRFont
public void setBold(boolean isBold)
setBold
in interface JRFont
public void setBold(java.lang.Boolean isBold)
setBold
in interface JRFont
public boolean isItalic()
isItalic
in interface JRFont
public java.lang.Boolean isOwnItalic()
isOwnItalic
in interface JRFont
public void setItalic(boolean isItalic)
setItalic
in interface JRFont
public void setItalic(java.lang.Boolean isItalic)
setItalic
in interface JRFont
public boolean isUnderline()
isUnderline
in interface JRFont
public java.lang.Boolean isOwnUnderline()
isOwnUnderline
in interface JRFont
public void setUnderline(boolean isUnderline)
setUnderline
in interface JRFont
public void setUnderline(java.lang.Boolean isUnderline)
setUnderline
in interface JRFont
public boolean isStrikeThrough()
isStrikeThrough
in interface JRFont
public java.lang.Boolean isOwnStrikeThrough()
isOwnStrikeThrough
in interface JRFont
public void setStrikeThrough(boolean isStrikeThrough)
setStrikeThrough
in interface JRFont
public void setStrikeThrough(java.lang.Boolean isStrikeThrough)
setStrikeThrough
in interface JRFont
public int getFontSize()
getFontSize
in interface JRCommonText
getFontSize
in interface JRFont
public java.lang.Integer getOwnFontSize()
getOwnFontSize
in interface JRFont
public void setFontSize(int fontSize)
setFontSize
in interface JRFont
public void setFontSize(java.lang.Integer fontSize)
setFontSize
in interface JRFont
public java.lang.String getPdfFontName()
getPdfFontName
in interface JRFont
public java.lang.String getOwnPdfFontName()
getOwnPdfFontName
in interface JRFont
public void setPdfFontName(java.lang.String pdfFontName)
setPdfFontName
in interface JRFont
public java.lang.String getPdfEncoding()
getPdfEncoding
in interface JRFont
public java.lang.String getOwnPdfEncoding()
getOwnPdfEncoding
in interface JRFont
public void setPdfEncoding(java.lang.String pdfEncoding)
setPdfEncoding
in interface JRFont
public boolean isPdfEmbedded()
isPdfEmbedded
in interface JRFont
public java.lang.Boolean isOwnPdfEmbedded()
isOwnPdfEmbedded
in interface JRFont
public void setPdfEmbedded(boolean isPdfEmbedded)
setPdfEmbedded
in interface JRFont
public void setPdfEmbedded(java.lang.Boolean isPdfEmbedded)
setPdfEmbedded
in interface JRFont
public JRStyle getStyle()
JRStyleContainer
getStyle
in interface JRStyleContainer
getStyle
in class JRTemplateElement
public java.lang.String getPattern()
getPattern
in interface TextFormat
public void setPattern(java.lang.String pattern)
public java.lang.String getValueClassName()
getValueClassName
in interface TextFormat
public void setValueClassName(java.lang.String valueClassName)
public java.lang.String getFormatFactoryClass()
getFormatFactoryClass
in interface TextFormat
public void setFormatFactoryClass(java.lang.String formatFactoryClass)
public java.lang.String getLocaleCode()
getLocaleCode
in interface TextFormat
public void setLocaleCode(java.lang.String localeCode)
public java.lang.String getTimeZoneId()
getTimeZoneId
in interface TextFormat
public void setTimeZoneId(java.lang.String timeZoneId)
public java.lang.String getLinkType()
The type can be one of the built-in types (Reference, LocalAnchor, LocalPage, RemoteAnchor, RemotePage), or can be an arbitrary type.
public void setLinkType(java.lang.String linkType)
The type can be one of the built-in types (Reference, LocalAnchor, LocalPage, RemoteAnchor, RemotePage), or can be an arbitrary type.
linkType
- the hyperlink typeprotected void setLinkTarget(java.lang.String linkTarget)
public java.lang.String getLinkTarget()
The target name can be one of the built-in names (Self, Blank, Top, Parent), or can be an arbitrary name.
public java.awt.Color getDefaultLineColor()
getDefaultLineColor
in interface JRBoxContainer
public int getHashCode()
Deduplicable
Deduplicable.isIdentical(Object)
,
i.e. if two objects are identical they should have the same hash code.
getHashCode
in interface Deduplicable
public boolean isIdentical(java.lang.Object object)
Deduplicable
isIdentical
in interface Deduplicable
object
- the object to compare with this instance
true
if the two objects are identical and can be deduplicated
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |