|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object net.sf.jasperreports.engine.fill.JRFillElement net.sf.jasperreports.engine.fill.JRFillTextElement net.sf.jasperreports.engine.fill.JRFillTextField
public class JRFillTextField
Field Summary |
---|
Fields inherited from class net.sf.jasperreports.engine.fill.JRFillTextElement |
---|
lineBox, paragraph |
Fields inherited from class net.sf.jasperreports.engine.fill.JRFillElement |
---|
band, conditionalStylesContainer, currentEvaluation, currentStyle, defaultStyleProvider, delayedEvaluationsMap, dynamicProperties, elementGroup, elementId, expressionEvaluator, filler, initStyle, mergedProperties, originProvider, parent, printWhenGroupChanges, staticProperties, templates |
Fields inherited from interface net.sf.jasperreports.engine.JRTextElement |
---|
PROPERTY_PRINT_KEEP_FULL_TEXT, PROPERTY_SAVE_LINE_BREAKS, PROPERTY_TRUNCATE_AT_CHAR, PROPERTY_TRUNCATE_SUFFIX |
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 |
Fields inherited from interface net.sf.jasperreports.engine.JRAnchor |
---|
NO_BOOKMARK |
Constructor Summary | |
---|---|
protected |
JRFillTextField(JRBaseFiller filler,
JRTextField textField,
JRFillObjectFactory factory)
|
protected |
JRFillTextField(JRFillTextField textField,
JRFillCloneFactory factory)
|
Method Summary | |
---|---|
protected boolean |
canOverflow()
|
protected void |
collectDelayedEvaluations()
|
void |
collectExpressions(JRExpressionCollector collector)
|
protected void |
copy(JRPrintText text)
|
JRFillCloneable |
createClone(JRFillCloneFactory factory)
Creates a working clone of itself. |
protected JRTemplateElement |
createElementTemplate()
|
protected void |
evaluate(byte evaluation)
|
protected void |
evaluateText(byte evaluation)
|
protected void |
evaluateTextFormat(java.text.Format format,
java.lang.Object value)
|
protected JRPrintElement |
fill()
|
protected java.lang.String |
getAnchorName()
|
JRExpression |
getAnchorNameExpression()
Returns an expression whose value represents the anchor name. |
int |
getBookmarkLevel()
Returns the level of the bookmark corresponding to the anchor. |
JRGroup |
getEvaluationGroup()
Gets the evaluation group for this text field. |
EvaluationTimeEnum |
getEvaluationTimeValue()
Gets the evaluation time for this text field. |
JRExpression |
getExpression()
Gets the expression for this field. |
protected java.text.Format |
getFormat(java.lang.Object value)
|
protected java.lang.String |
getHyperlinkAnchor()
|
JRExpression |
getHyperlinkAnchorExpression()
Returns the expression whose value represents the anchor. |
protected java.lang.Integer |
getHyperlinkPage()
|
JRExpression |
getHyperlinkPageExpression()
Returns an integer representing the page index of the link. |
JRHyperlinkParameter[] |
getHyperlinkParameters()
Returns the list of hyperlink parameters. |
protected java.lang.String |
getHyperlinkReference()
|
JRExpression |
getHyperlinkReferenceExpression()
Returns the expression whose value represents the hyperlink reference. |
byte |
getHyperlinkTarget()
Retrieves the hyperlink target for the element. |
protected java.lang.String |
getHyperlinkTooltip()
|
JRExpression |
getHyperlinkTooltipExpression()
Returns the expression which will generate the hyperlink tooltip. |
byte |
getHyperlinkType()
Deprecated. Replaced by getHyperlinkTypeValue() . |
HyperlinkTypeEnum |
getHyperlinkTypeValue()
Retrieves the hyperlink type for the element. |
protected JRTemplateText |
getJRTemplateText()
|
java.lang.String |
getLinkTarget()
Returns the hyperlink target name. |
java.lang.String |
getLinkType()
Returns the hyperlink type. |
java.lang.String |
getOwnPattern()
|
java.lang.String |
getPattern()
Gets the pattern used for this text field. |
JRExpression |
getPatternExpression()
Gets the pattern expression, in case the patter needs to be dynamic. |
protected java.lang.String |
getTemplatePattern(java.text.Format format,
java.lang.Object value)
|
protected TextFormat |
getTextFormat()
|
protected java.lang.Object |
getValue()
|
boolean |
isBlankWhenNull()
Indicates whether an empty string will be displayed if the field's expression evaluates to null . |
java.lang.Boolean |
isOwnBlankWhenNull()
|
boolean |
isStretchWithOverflow()
Specifies whether the text field will stretch vertically if its text does not fit in one line. |
protected boolean |
prepare(int availableHeight,
boolean isOverflow)
|
protected void |
resolveElement(JRPrintElement element,
byte evaluation)
Resolves an element. |
void |
setBlankWhenNull(boolean isBlank)
Specifies whether an empty string sholuld be displayed if the field's expression evaluates to null . |
void |
setBlankWhenNull(java.lang.Boolean isBlank)
|
void |
setPattern(java.lang.String pattern)
Sets the pattern used for this text field. |
void |
setStretchWithOverflow(boolean isStretchWithOverflow)
Set to true if the text field should stretch vertically if its text does not fit in one line. |
void |
visit(JRVisitor visitor)
|
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface net.sf.jasperreports.engine.JRElement |
---|
getElementGroup, getKey, getPositionTypeValue, getPrintWhenExpression, getPrintWhenGroupChanges, getPropertyExpressions, getStretchTypeValue, getX, getY, isPrintInFirstWholeBand, isPrintRepeatedValues, isPrintWhenDetailOverflows, isRemoveLineWhenBlank, setPositionType, setPrintInFirstWholeBand, setPrintRepeatedValues, setPrintWhenDetailOverflows, setRemoveLineWhenBlank, setStretchType, setWidth, setX |
Methods inherited from interface net.sf.jasperreports.engine.JRChild |
---|
clone |
Methods inherited from interface net.sf.jasperreports.engine.JRCloneable |
---|
clone |
Methods inherited from interface net.sf.jasperreports.engine.JRPropertiesHolder |
---|
getParentProperties, getPropertiesMap, hasProperties |
Methods inherited from interface net.sf.jasperreports.engine.JRAlignment |
---|
getHorizontalAlignmentValue, getOwnHorizontalAlignmentValue, getOwnVerticalAlignmentValue, getVerticalAlignmentValue, setHorizontalAlignment, setVerticalAlignment |
Methods inherited from interface net.sf.jasperreports.engine.JRFont |
---|
getFontName, getFontSize, getOwnFontName, getOwnFontSize, getOwnPdfEncoding, getOwnPdfFontName, getPdfEncoding, getPdfFontName, isBold, isItalic, isOwnBold, isOwnItalic, isOwnPdfEmbedded, isOwnStrikeThrough, isOwnUnderline, isPdfEmbedded, isStrikeThrough, isUnderline, setBold, setBold, setFontName, setFontSize, setFontSize, setItalic, setItalic, setPdfEmbedded, setPdfEmbedded, setPdfEncoding, setPdfFontName, setStrikeThrough, setStrikeThrough, setUnderline, setUnderline |
Methods inherited from interface net.sf.jasperreports.engine.JRCommonText |
---|
getFontSize, getLineSpacingValue, getMarkup, getOwnLineSpacingValue, getOwnMarkup, getOwnRotationValue, getRotationValue, setLineSpacing, setMarkup, setRotation |
Methods inherited from interface net.sf.jasperreports.engine.JRCommonElement |
---|
getBackcolor, getForecolor, getHeight, getModeValue, 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.JRBoxContainer |
---|
getDefaultLineColor, getLineBox |
Methods inherited from interface net.sf.jasperreports.engine.JRParagraphContainer |
---|
getParagraph |
Methods inherited from interface net.sf.jasperreports.engine.JRStyleContainer |
---|
getDefaultStyleProvider, getStyle, getStyleNameReference |
Constructor Detail |
---|
protected JRFillTextField(JRBaseFiller filler, JRTextField textField, JRFillObjectFactory factory)
protected JRFillTextField(JRFillTextField textField, JRFillCloneFactory factory)
Method Detail |
---|
public boolean isStretchWithOverflow()
JRTextField
isStretchWithOverflow
in interface JRTextField
public void setStretchWithOverflow(boolean isStretchWithOverflow)
JRTextField
setStretchWithOverflow
in interface JRTextField
public EvaluationTimeEnum getEvaluationTimeValue()
JRTextField
getEvaluationTimeValue
in interface JRTextField
getEvaluationTimeValue
in class JRFillElement
JRExpression
protected TextFormat getTextFormat()
public java.lang.String getPattern()
JRTextField
getPattern
in interface JRTextField
public java.lang.String getOwnPattern()
getOwnPattern
in interface JRTextField
public void setPattern(java.lang.String pattern)
JRTextField
setPattern
in interface JRTextField
public boolean isBlankWhenNull()
JRTextField
null
.
isBlankWhenNull
in interface JRTextField
public java.lang.Boolean isOwnBlankWhenNull()
isOwnBlankWhenNull
in interface JRTextField
public void setBlankWhenNull(boolean isBlank)
JRTextField
null
.
setBlankWhenNull
in interface JRTextField
isBlank
- true if an empty string will be displayed instead of null values, false otherwisepublic void setBlankWhenNull(java.lang.Boolean isBlank)
setBlankWhenNull
in interface JRTextField
public byte getHyperlinkType()
getHyperlinkTypeValue()
.
getHyperlinkType
in interface JRHyperlink
public HyperlinkTypeEnum getHyperlinkTypeValue()
JRHyperlink
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.
When hyperlink is of custom type, CUSTOM
is returned.
getHyperlinkTypeValue
in interface JRHyperlink
JRHyperlink.getLinkType()
public byte getHyperlinkTarget()
JRHyperlink
The actual hyperlink target is determined by getLinkTarget()
.
This method can is used to determine whether the hyperlink target is one of the
built-in target names or a custom one.
When hyperlink has a custom target name, HyperlinkTargetEnum.CUSTOM
is returned.
getHyperlinkTarget
in interface JRHyperlink
JRHyperlink.getLinkTarget()
public java.lang.String getLinkTarget()
JRHyperlink
The type can be one of the built-in names (Self, Blank, Top, Parent), or can be an arbitrary name.
getLinkTarget
in interface JRHyperlink
public JRGroup getEvaluationGroup()
JRTextField
getEvaluationGroup
in interface JRTextField
EvaluationTimeEnum.GROUP
public JRExpression getExpression()
JRTextField
getExpression
in interface JRTextField
public JRExpression getPatternExpression()
JRTextField
getPatternExpression
in interface JRTextField
JRTextField.getPattern()
public JRExpression getAnchorNameExpression()
JRAnchor
getAnchorNameExpression
in interface JRAnchor
public JRExpression getHyperlinkReferenceExpression()
JRHyperlink
getHyperlinkReferenceExpression
in interface JRHyperlink
public JRExpression getHyperlinkAnchorExpression()
JRHyperlink
getHyperlinkAnchorExpression
in interface JRHyperlink
public JRExpression getHyperlinkPageExpression()
JRHyperlink
getHyperlinkPageExpression
in interface JRHyperlink
protected java.lang.Object getValue()
protected java.lang.String getAnchorName()
protected java.lang.String getHyperlinkReference()
protected java.lang.String getHyperlinkAnchor()
protected java.lang.Integer getHyperlinkPage()
protected java.lang.String getHyperlinkTooltip()
protected JRTemplateText getJRTemplateText()
protected JRTemplateElement createElementTemplate()
createElementTemplate
in class JRFillElement
protected void evaluateTextFormat(java.text.Format format, java.lang.Object value)
protected void evaluate(byte evaluation) throws JRException
evaluate
in class JRFillElement
JRException
protected void evaluateText(byte evaluation) throws JRException
JRException
protected boolean prepare(int availableHeight, boolean isOverflow) throws JRException
prepare
in class JRFillElement
JRException
protected JRPrintElement fill() throws JRException
fill
in class JRFillElement
JRException
protected void copy(JRPrintText text)
protected java.text.Format getFormat(java.lang.Object value)
protected java.lang.String getTemplatePattern(java.text.Format format, java.lang.Object value)
public void collectExpressions(JRExpressionCollector collector)
collectExpressions
in interface JRElement
public void visit(JRVisitor visitor)
visit
in interface JRVisitable
protected void resolveElement(JRPrintElement element, byte evaluation) throws JRException
JRFillElement
resolveElement
in class JRFillElement
element
- the elementevaluation
- the evaluation type
JRException
public int getBookmarkLevel()
JRAnchor
getBookmarkLevel
in interface JRAnchor
NO_BOOKMARK
if no bookmark should be created for this anchorpublic JRFillCloneable createClone(JRFillCloneFactory factory)
JRFillCloneable
createClone
in interface JRFillCloneable
factory
- the clone factory to use while creating the clone
protected void collectDelayedEvaluations()
collectDelayedEvaluations
in class JRFillElement
public JRHyperlinkParameter[] getHyperlinkParameters()
JRHyperlink
The parameters can be used by custom hyperlink types to generate dynamic links.
getHyperlinkParameters
in interface JRHyperlink
public java.lang.String getLinkType()
JRHyperlink
The type can be one of the built-in types (Reference, LocalAnchor, LocalPage, RemoteAnchor, RemotePage), or can be an arbitrary type.
getLinkType
in interface JRHyperlink
public JRExpression getHyperlinkTooltipExpression()
JRHyperlink
getHyperlinkTooltipExpression
in interface JRHyperlink
protected boolean canOverflow()
canOverflow
in class JRFillTextElement
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |