Class JRDesignHyperlink

    • Field Detail

      • PROPERTY_HYPERLINK_ANCHOR_EXPRESSION

        public static final java.lang.String PROPERTY_HYPERLINK_ANCHOR_EXPRESSION
        See Also:
        Constant Field Values
      • PROPERTY_HYPERLINK_PAGE_EXPRESSION

        public static final java.lang.String PROPERTY_HYPERLINK_PAGE_EXPRESSION
        See Also:
        Constant Field Values
      • PROPERTY_HYPERLINK_REFERENCE_EXPRESSION

        public static final java.lang.String PROPERTY_HYPERLINK_REFERENCE_EXPRESSION
        See Also:
        Constant Field Values
      • PROPERTY_HYPERLINK_WHEN_EXPRESSION

        public static final java.lang.String PROPERTY_HYPERLINK_WHEN_EXPRESSION
        See Also:
        Constant Field Values
      • PROPERTY_HYPERLINK_TARGET

        public static final java.lang.String PROPERTY_HYPERLINK_TARGET
        See Also:
        Constant Field Values
      • PROPERTY_LINK_TARGET

        public static final java.lang.String PROPERTY_LINK_TARGET
        See Also:
        Constant Field Values
      • PROPERTY_HYPERLINK_TOOLTIP_EXPRESSION

        public static final java.lang.String PROPERTY_HYPERLINK_TOOLTIP_EXPRESSION
        See Also:
        Constant Field Values
      • PROPERTY_LINK_TYPE

        public static final java.lang.String PROPERTY_LINK_TYPE
        See Also:
        Constant Field Values
      • PROPERTY_HYPERLINK_PARAMETERS

        public static final java.lang.String PROPERTY_HYPERLINK_PARAMETERS
        See Also:
        Constant Field Values
    • Constructor Detail

      • JRDesignHyperlink

        public JRDesignHyperlink()
    • Method Detail

      • 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:
        JRBaseHyperlink.getLinkType()
      • setHyperlinkWhenExpression

        public void setHyperlinkWhenExpression​(JRExpression hyperlinkWhenExpression)
        Sets the boolean expression that will specify if the hyperlink should be displayed or not.
      • setLinkType

        public void setLinkType​(java.lang.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
      • setLinkTarget

        public void setLinkTarget​(java.lang.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
      • getHyperlinkParametersList

        public java.util.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​(java.lang.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
      • setHyperlinkTooltipExpression

        public void setHyperlinkTooltipExpression​(JRExpression hyperlinkTooltipExpression)
        Sets the expression which will be used to generate the hyperlink tooltip. The type of the expression should be java.lang.String.
        Parameters:
        hyperlinkTooltipExpression - the expression which will be used to generate the hyperlink tooltip
        See Also:
        JRBaseHyperlink.getHyperlinkTooltipExpression()