Package net.sf.jasperreports.engine.design

Class JRDesignTextField

    • Constructor Detail

      • JRDesignTextField

        public JRDesignTextField()

    • Method Detail

      • isStretchWithOverflow

        public boolean isStretchWithOverflow()
        Deprecated.
        Replaced by getTextAdjust().
        Description copied from interface: JRTextField
        Specifies whether the text field will stretch vertically if its text does not fit in one line.
        Specified by:
        isStretchWithOverflow in interface JRTextField
        Returns:
        true if the text field will stretch vertically, false otherwise

      • getPattern

        public String getPattern()
        Description copied from interface: JRTextField
        Gets the pattern used for this text field. The pattern will be used in a SimpleDateFormat for dates and a DecimalFormat for numeric text fields. The pattern format must follow one of these two classes formatting rules, as specified in the JDK API docs.
        Specified by:
        getPattern in interface JRTextField
        Returns:
        a string containing the pattern.

      • isBlankWhenNull

        public boolean isBlankWhenNull()
        Description copied from interface: JRTextField
        Indicates whether an empty string will be displayed if the field's expression evaluates to null.
        Specified by:
        isBlankWhenNull in interface JRTextField
        Returns:
        true if an empty string will be displayed instead of null values, false otherwise

      • getHyperlinkTypeValue

        public HyperlinkTypeEnum getHyperlinkTypeValue()
        Description copied from interface: JRHyperlink
        Retrieves the hyperlink type for the element.

        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.

        Specified by:
        getHyperlinkTypeValue in interface JRHyperlink
        Returns:
        one of the hyperlink type constants
        See Also:
        JRHyperlink.getLinkType()

      • getExpression

        public JRExpression getExpression()
        Description copied from interface: JRTextField
        Gets the expression for this field. The result obtained after evaluating this expression will be dispayed as the field text.
        Specified by:
        getExpression in interface JRTextField

      • getBookmarkLevelExpression

        public JRExpression getBookmarkLevelExpression()
        Description copied from interface: JRAnchor
        Returns an expression whose value represents the bookmark level (starting from 1) corresponding to this anchor. When the expression is set and its value is not null, it will override the value of the bookmarkLevel attribute.
        Specified by:
        getBookmarkLevelExpression in interface JRAnchor

      • getHyperlinkReferenceExpression

        public JRExpression getHyperlinkReferenceExpression()
        Description copied from interface: JRHyperlink
        Returns the expression whose value represents the hyperlink reference. It is only used when the hyperlink type is reference or anchor
        Specified by:
        getHyperlinkReferenceExpression in interface JRHyperlink

      • getHyperlinkWhenExpression

        public JRExpression getHyperlinkWhenExpression()
        Description copied from interface: JRHyperlink
        Returns the expression that is evaluated in order to decide if the hyperlink should be displayed. This expression always returns a boolean value.
        Specified by:
        getHyperlinkWhenExpression in interface JRHyperlink

      • getHyperlinkAnchorExpression

        public JRExpression getHyperlinkAnchorExpression()
        Description copied from interface: JRHyperlink
        Returns the expression whose value represents the anchor. It is only used when the hyperlink type is anchor.
        Specified by:
        getHyperlinkAnchorExpression in interface JRHyperlink

      • getHyperlinkPageExpression

        public JRExpression getHyperlinkPageExpression()
        Description copied from interface: JRHyperlink
        Returns an integer representing the page index of the link. It is only used when the hyperlink type is page. If the expression does not evaluate to an integer, an exception will be thrown.
        Specified by:
        getHyperlinkPageExpression in interface JRHyperlink

      • setEvaluationTime

        public void setEvaluationTime​(EvaluationTimeEnum evaluationTimeValue)

      • setPattern

        public void setPattern​(String pattern)
        Description copied from interface: JRTextField
        Sets the pattern used for this text field. The pattern will be used in a SimpleDateFormat for dates and a DecimalFormat for numeric text fields. The pattern format must follow one of these two classes formatting rules, as specified in the JDK API docs. If the pattern is incorrect, the exception thrown by formatter classes will be rethrown by the JasperReports fill engine.
        Specified by:
        setPattern in interface JRTextField

      • setBlankWhenNull

        public void setBlankWhenNull​(boolean isBlank)
        Description copied from interface: JRTextField
        Specifies whether an empty string sholuld be displayed if the field's expression evaluates to null.
        Specified by:
        setBlankWhenNull in interface JRTextField
        Parameters:
        isBlank - true if an empty string will be displayed instead of null values, false otherwise

      • setHyperlinkType

        public void setHyperlinkType​(HyperlinkTypeEnum hyperlinkType)
        Sets the link type as a built-in hyperlink type.
        Parameters:
        hyperlinkType - the built-in hyperlink type
        See Also:
        getLinkType()

      • setEvaluationGroup

        public void setEvaluationGroup​(JRGroup evaluationGroup)

      • setExpression

        public void setExpression​(JRExpression expression)

      • setPatternExpression

        public void setPatternExpression​(JRExpression patternExpression)

      • setAnchorNameExpression

        public void setAnchorNameExpression​(JRExpression anchorNameExpression)

      • setBookmarkLevelExpression

        public void setBookmarkLevelExpression​(JRExpression bookmarkLevelExpression)

      • setHyperlinkReferenceExpression

        public void setHyperlinkReferenceExpression​(JRExpression hyperlinkReferenceExpression)

      • setHyperlinkWhenExpression

        public void setHyperlinkWhenExpression​(JRExpression hyperlinkWhenExpression)

      • setHyperlinkAnchorExpression

        public void setHyperlinkAnchorExpression​(JRExpression hyperlinkAnchorExpression)

      • setHyperlinkPageExpression

        public void setHyperlinkPageExpression​(JRExpression hyperlinkPageExpression)

      • getBookmarkLevel

        public int getBookmarkLevel()
        Description copied from interface: JRAnchor
        Returns the level of the bookmark corresponding to the anchor.
        Specified by:
        getBookmarkLevel in interface JRAnchor
        Returns:
        the level of the bookmark corresponding to the anchor (starting from 1) or NO_BOOKMARK if no bookmark should be created for this anchor

      • setBookmarkLevel

        public void setBookmarkLevel​(int bookmarkLevel)
        Sets the boomark level for the anchor associated with this field.
        Parameters:
        bookmarkLevel - the bookmark level (starting from 1) or NO_BOOKMARK if no bookmark should be created

      • getLinkType

        public String getLinkType()
        Description copied from interface: JRHyperlink
        Returns the hyperlink type.

        The type can be one of the built-in types (Reference, LocalAnchor, LocalPage, RemoteAnchor, RemotePage), or can be an arbitrary type.

        Specified by:
        getLinkType in interface JRHyperlink
        Returns:
        the hyperlink type

      • setLinkType

        public void setLinkType​(String type)
        Sets the hyperlink type.

        The type can be one of the built-in types (Reference, LocalAnchor, LocalPage, RemoteAnchor, RemotePage), or can be an arbitrary type.

        Parameters:
        type - the hyperlink type

      • getLinkTarget

        public String getLinkTarget()
        Description copied from interface: JRHyperlink
        Returns the hyperlink target name.

        The type can be one of the built-in names (Self, Blank, Top, Parent), or can be an arbitrary name.

        Specified by:
        getLinkTarget in interface JRHyperlink
        Returns:
        the hyperlink target name

      • setLinkTarget

        public void setLinkTarget​(String target)
        Sets the hyperlink target name.

        The target name can be one of the built-in names (Self, Blank, Top, Parent), or can be an arbitrary name.

        Parameters:
        target - the hyperlink target name

      • getHyperlinkParameters

        public JRHyperlinkParameter[] getHyperlinkParameters()
        Description copied from interface: JRHyperlink
        Returns the list of hyperlink parameters.

        The parameters can be used by custom hyperlink types to generate dynamic links.

        Specified by:
        getHyperlinkParameters in interface JRHyperlink
        Returns:
        the list of hyperlink parameters

      • getHyperlinkParametersList

        public List<JRHyperlinkParameter> getHyperlinkParametersList()
        Returns the list of custom hyperlink parameters.
        Returns:
        the list of custom hyperlink parameters

      • addHyperlinkParameter

        public void addHyperlinkParameter​(JRHyperlinkParameter parameter)
        Adds a custom hyperlink parameter.
        Parameters:
        parameter - the parameter to add

      • removeHyperlinkParameter

        public void removeHyperlinkParameter​(JRHyperlinkParameter parameter)
        Removes a custom hyperlink parameter.
        Parameters:
        parameter - the parameter to remove

      • removeHyperlinkParameter

        public void removeHyperlinkParameter​(String parameterName)
        Removes a custom hyperlink parameter.

        If multiple parameters having the specified name exist, all of them will be removed

        Parameters:
        parameterName - the parameter name

      • getHyperlinkTooltipExpression

        public JRExpression getHyperlinkTooltipExpression()
        Description copied from interface: JRHyperlink
        Returns the expression which will generate the hyperlink tooltip.
        Specified by:
        getHyperlinkTooltipExpression in interface JRHyperlink
        Returns:
        the expression which will generate the hyperlink tooltip

      • setHyperlinkTooltipExpression

        public void setHyperlinkTooltipExpression​(JRExpression hyperlinkTooltipExpression)
        Sets the expression which will be used to generate the hyperlink tooltip.
        Parameters:
        hyperlinkTooltipExpression - the expression which will be used to generate the hyperlink tooltip
        See Also:
        getHyperlinkTooltipExpression()