|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectnet.sf.jasperreports.engine.base.JRBaseElement
net.sf.jasperreports.engine.base.JRBaseTextElement
net.sf.jasperreports.engine.base.JRBaseTextField
public class JRBaseTextField
This class is used for representing a text field.
| Field Summary | |
|---|---|
protected JRExpression |
anchorNameExpression
|
protected int |
bookmarkLevel
The bookmark level for the anchor associated with this field. |
protected JRGroup |
evaluationGroup
|
protected EvaluationTimeEnum |
evaluationTimeValue
|
protected JRExpression |
expression
|
protected JRExpression |
hyperlinkAnchorExpression
|
protected JRExpression |
hyperlinkPageExpression
|
protected JRExpression |
hyperlinkReferenceExpression
|
protected java.lang.Boolean |
isBlankWhenNull
|
protected boolean |
isStretchWithOverflow
|
protected java.lang.String |
linkTarget
|
protected java.lang.String |
linkType
|
protected java.lang.String |
pattern
|
static java.lang.String |
PROPERTY_STRETCH_WITH_OVERFLOW
|
| Fields inherited from class net.sf.jasperreports.engine.base.JRBaseTextElement |
|---|
fontName, fontSize, horizontalAlignmentValue, isBold, isItalic, isPdfEmbedded, isStrikeThrough, isUnderline, lineBox, lineSpacingValue, markup, pdfEncoding, pdfFontName, reportFont, rotationValue, verticalAlignmentValue |
| Fields inherited from interface net.sf.jasperreports.engine.JRTextField |
|---|
STANDARD_DATE_FORMAT_DEFAULT, STANDARD_DATE_FORMAT_FULL, STANDARD_DATE_FORMAT_HIDE, STANDARD_DATE_FORMAT_LONG, STANDARD_DATE_FORMAT_MEDIUM, STANDARD_DATE_FORMAT_SEPARATOR, STANDARD_DATE_FORMAT_SHORT |
| Fields inherited from interface net.sf.jasperreports.engine.JRTextElement |
|---|
LINE_SPACING_1_1_2, LINE_SPACING_DOUBLE, LINE_SPACING_SINGLE, PROPERTY_PRINT_KEEP_FULL_TEXT, PROPERTY_SAVE_LINE_BREAKS, PROPERTY_TRUNCATE_AT_CHAR, PROPERTY_TRUNCATE_SUFFIX, ROTATION_LEFT, ROTATION_NONE, ROTATION_RIGHT, ROTATION_UPSIDE_DOWN, TEXT_ALIGN_CENTER, TEXT_ALIGN_JUSTIFIED, TEXT_ALIGN_LEFT, TEXT_ALIGN_RIGHT |
| Fields inherited from interface net.sf.jasperreports.engine.JRElement |
|---|
MODE_OPAQUE, MODE_TRANSPARENT, POSITION_TYPE_FIX_RELATIVE_TO_BOTTOM, POSITION_TYPE_FIX_RELATIVE_TO_TOP, POSITION_TYPE_FLOAT, STRETCH_TYPE_NO_STRETCH, STRETCH_TYPE_RELATIVE_TO_BAND_HEIGHT, STRETCH_TYPE_RELATIVE_TO_TALLEST_OBJECT |
| Fields inherited from interface net.sf.jasperreports.engine.JRAlignment |
|---|
HORIZONTAL_ALIGN_CENTER, HORIZONTAL_ALIGN_JUSTIFIED, HORIZONTAL_ALIGN_LEFT, HORIZONTAL_ALIGN_RIGHT, VERTICAL_ALIGN_BOTTOM, VERTICAL_ALIGN_JUSTIFIED, VERTICAL_ALIGN_MIDDLE, VERTICAL_ALIGN_TOP |
| 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 |
| Fields inherited from interface net.sf.jasperreports.engine.JRHyperlink |
|---|
HYPERLINK_TARGET_BLANK, HYPERLINK_TARGET_CUSTOM, HYPERLINK_TARGET_PARENT, HYPERLINK_TARGET_SELF, HYPERLINK_TARGET_TOP, HYPERLINK_TYPE_CUSTOM, HYPERLINK_TYPE_LOCAL_ANCHOR, HYPERLINK_TYPE_LOCAL_PAGE, HYPERLINK_TYPE_NONE, HYPERLINK_TYPE_NULL, HYPERLINK_TYPE_REFERENCE, HYPERLINK_TYPE_REMOTE_ANCHOR, HYPERLINK_TYPE_REMOTE_PAGE |
| Constructor Summary | |
|---|---|
protected |
JRBaseTextField(JRTextField textField,
JRBaseObjectFactory factory)
Initializes the text field properties. |
| Method Summary | |
|---|---|
java.lang.Object |
clone()
|
void |
collectExpressions(JRExpressionCollector collector)
|
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. |
byte |
getEvaluationTime()
Deprecated. Replaced by getEvaluationTimeValue(). |
EvaluationTimeEnum |
getEvaluationTimeValue()
Gets the evaluation time for this text field. |
JRExpression |
getExpression()
Gets the expression for this field. |
JRExpression |
getHyperlinkAnchorExpression()
Returns the expression whose value represents the anchor. |
JRExpression |
getHyperlinkPageExpression()
Returns an integer representing the page index of the link. |
JRHyperlinkParameter[] |
getHyperlinkParameters()
Returns the list of hyperlink parameters. |
JRExpression |
getHyperlinkReferenceExpression()
Returns the expression whose value represents the hyperlink reference. |
byte |
getHyperlinkTarget()
Retrieves the hyperlink target for the element. |
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. |
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. |
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. |
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.JRTextElement |
|---|
getBox, getFont, getTextAlignment, setStyledText, setStyledText, setTextAlignment |
| Methods inherited from interface net.sf.jasperreports.engine.JRElement |
|---|
getElementGroup, getKey, getPositionType, getPositionTypeValue, getPrintWhenExpression, getPrintWhenGroupChanges, getPropertyExpressions, getStretchType, getStretchTypeValue, getX, getY, isPrintInFirstWholeBand, isPrintRepeatedValues, isPrintWhenDetailOverflows, isRemoveLineWhenBlank, setPositionType, setPositionType, setPrintInFirstWholeBand, setPrintRepeatedValues, setPrintWhenDetailOverflows, setRemoveLineWhenBlank, setStretchType, setStretchType, setWidth, setX |
| Methods inherited from interface net.sf.jasperreports.engine.JRChild |
|---|
clone |
| Methods inherited from interface net.sf.jasperreports.engine.JRPropertiesHolder |
|---|
getParentProperties, getPropertiesMap, hasProperties |
| Methods inherited from interface net.sf.jasperreports.engine.JRAlignment |
|---|
getHorizontalAlignment, getHorizontalAlignmentValue, getOwnHorizontalAlignment, getOwnHorizontalAlignmentValue, getOwnVerticalAlignment, getOwnVerticalAlignmentValue, getVerticalAlignment, getVerticalAlignmentValue, setHorizontalAlignment, setHorizontalAlignment, setHorizontalAlignment, setVerticalAlignment, setVerticalAlignment, setVerticalAlignment |
| Methods inherited from interface net.sf.jasperreports.engine.JRFont |
|---|
getFontName, getFontSize, getOwnFontName, getOwnFontSize, getOwnPdfEncoding, getOwnPdfFontName, getOwnSize, getPdfEncoding, getPdfFontName, getReportFont, getSize, isBold, isItalic, isOwnBold, isOwnItalic, isOwnPdfEmbedded, isOwnStrikeThrough, isOwnUnderline, isPdfEmbedded, isStrikeThrough, isUnderline, setBold, setBold, setFontName, setFontSize, setFontSize, setItalic, setItalic, setPdfEmbedded, setPdfEmbedded, setPdfEncoding, setPdfFontName, setReportFont, setSize, setSize, setStrikeThrough, setStrikeThrough, setUnderline, setUnderline |
| Methods inherited from interface net.sf.jasperreports.engine.JRCommonText |
|---|
getFontSize, getLineSpacing, getLineSpacingValue, getMarkup, getOwnLineSpacing, getOwnLineSpacingValue, getOwnMarkup, getOwnRotation, getOwnRotationValue, getRotation, getRotationValue, isOwnStyledText, isStyledText, setLineSpacing, setLineSpacing, setLineSpacing, setMarkup, setRotation, setRotation, setRotation |
| Methods inherited from interface net.sf.jasperreports.engine.JRCommonElement |
|---|
getBackcolor, getForecolor, getHeight, getMode, getModeValue, getOwnBackcolor, getOwnForecolor, getOwnMode, getOwnModeValue, getWidth, setBackcolor, setForecolor, setMode, setMode, setMode |
| Methods inherited from interface net.sf.jasperreports.engine.JRBoxContainer |
|---|
getDefaultLineColor, getLineBox |
| Methods inherited from interface net.sf.jasperreports.engine.JRStyleContainer |
|---|
getDefaultStyleProvider, getStyle, getStyleNameReference |
| Field Detail |
|---|
public static final java.lang.String PROPERTY_STRETCH_WITH_OVERFLOW
protected boolean isStretchWithOverflow
protected EvaluationTimeEnum evaluationTimeValue
protected java.lang.String pattern
protected java.lang.Boolean isBlankWhenNull
protected java.lang.String linkType
protected java.lang.String linkTarget
protected JRGroup evaluationGroup
protected JRExpression expression
protected JRExpression anchorNameExpression
protected JRExpression hyperlinkReferenceExpression
protected JRExpression hyperlinkAnchorExpression
protected JRExpression hyperlinkPageExpression
protected int bookmarkLevel
JRAnchor.getBookmarkLevel()| Constructor Detail |
|---|
protected JRBaseTextField(JRTextField textField,
JRBaseObjectFactory factory)
| Method Detail |
|---|
public boolean isStretchWithOverflow()
JRTextField
isStretchWithOverflow in interface JRTextFieldpublic void setStretchWithOverflow(boolean isStretchWithOverflow)
JRTextField
setStretchWithOverflow in interface JRTextFieldpublic byte getEvaluationTime()
getEvaluationTimeValue().
getEvaluationTime in interface JRTextFieldpublic EvaluationTimeEnum getEvaluationTimeValue()
JRTextField
getEvaluationTimeValue in interface JRTextFieldJRExpressionpublic java.lang.String getPattern()
JRTextField
getPattern in interface JRTextFieldpublic java.lang.String getOwnPattern()
getOwnPattern in interface JRTextFieldpublic void setPattern(java.lang.String pattern)
JRTextField
setPattern in interface JRTextFieldpublic boolean isBlankWhenNull()
JRTextFieldnull.
isBlankWhenNull in interface JRTextFieldpublic java.lang.Boolean isOwnBlankWhenNull()
isOwnBlankWhenNull in interface JRTextFieldpublic void setBlankWhenNull(java.lang.Boolean isBlank)
setBlankWhenNull in interface JRTextFieldpublic void setBlankWhenNull(boolean isBlank)
JRTextFieldnull.
setBlankWhenNull in interface JRTextFieldisBlank - true if an empty string will be displayed instead of null values, false otherwisepublic byte getHyperlinkType()
getHyperlinkTypeValue().
getHyperlinkType in interface JRHyperlinkpublic 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 JRHyperlinkJRHyperlink.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, HYPERLINK_TYPE_CUSTOM is returned.
getHyperlinkTarget in interface JRHyperlinkJRHyperlink.getLinkTarget()public JRGroup getEvaluationGroup()
JRTextField
getEvaluationGroup in interface JRTextFieldJRExpression.EVALUATION_TIME_GROUPpublic JRExpression getExpression()
JRTextField
getExpression in interface JRTextFieldpublic JRExpression getAnchorNameExpression()
JRAnchor
getAnchorNameExpression in interface JRAnchorpublic JRExpression getHyperlinkReferenceExpression()
JRHyperlink
getHyperlinkReferenceExpression in interface JRHyperlinkpublic JRExpression getHyperlinkAnchorExpression()
JRHyperlink
getHyperlinkAnchorExpression in interface JRHyperlinkpublic JRExpression getHyperlinkPageExpression()
JRHyperlink
getHyperlinkPageExpression in interface JRHyperlinkpublic void collectExpressions(JRExpressionCollector collector)
collectExpressions in interface JRElementpublic void visit(JRVisitor visitor)
visit in interface JRVisitablepublic int getBookmarkLevel()
JRAnchor
getBookmarkLevel in interface JRAnchorNO_BOOKMARK if no bookmark should be created for this anchorpublic java.lang.String getLinkType()
JRHyperlinkThe type can be one of the built-in types (Reference, LocalAnchor, LocalPage, RemoteAnchor, RemotePage), or can be an arbitrary type.
getLinkType in interface JRHyperlinkpublic java.lang.String getLinkTarget()
JRHyperlinkThe type can be one of the built-in names (Self, Blank, Top, Parent), or can be an arbitrary name.
getLinkTarget in interface JRHyperlinkpublic JRHyperlinkParameter[] getHyperlinkParameters()
JRHyperlinkThe parameters can be used by custom hyperlink types to generate dynamic links.
getHyperlinkParameters in interface JRHyperlinkpublic JRExpression getHyperlinkTooltipExpression()
JRHyperlink
getHyperlinkTooltipExpression in interface JRHyperlinkpublic java.lang.Object clone()
clone in interface JRCloneableclone in class JRBaseTextElement
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||