Package net.sf.jasperreports.engine.type

Enum HyperlinkTypeEnum

java.lang.Object
java.lang.Enum<HyperlinkTypeEnum>
net.sf.jasperreports.engine.type.HyperlinkTypeEnum
All Implemented Interfaces:
Serializable, Comparable<HyperlinkTypeEnum>, java.lang.constant.Constable, NamedEnum
public enum HyperlinkTypeEnum extends Enum<HyperlinkTypeEnum> implements NamedEnum
Author:
Teodor Danciu (teodord@users.sourceforge.net)

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    CUSTOM
    Custom hyperlink type.
    LOCAL_ANCHOR
    Constant useful for specifying that the hyperlink points to a local anchor, specified by the hyperlink anchor expression.
    LOCAL_PAGE
    Constant useful for specifying that the hyperlink points to a 1 based page index within the current document.
    NONE
    Constant useful for specifying that the element does not contain a hyperlink.
    NULL
    Not set hyperlink type.
    REFERENCE
    Constant useful for specifying that the hyperlink points to an external resource specified by the hyperlink reference expression.
    REMOTE_ANCHOR
    Constant useful for specifying that the hyperlink points to a remote anchor (specified by the hyperlink anchor expression) within an external document (specified by the hyperlink reference expression).
    REMOTE_PAGE
    Constant useful for specifying that the hyperlink points to a 1 based page index within an external document (specified by the hyperlink reference expression).

  • Method Summary

    Modifier and Type
    Method
    Description
    static HyperlinkTypeEnum
    getByName(String name)
     
    String
    getName()
     
    static HyperlinkTypeEnum
    valueOf(String name)
    Returns the enum constant of this type with the specified name.
    static HyperlinkTypeEnum[]
    values()
    Returns an array containing the constants of this enum type, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface net.sf.jasperreports.engine.type.NamedEnum

    getDefault

  • Enum Constant Details

    • NULL

      public static final HyperlinkTypeEnum NULL
      Not set hyperlink type.

    • NONE

      public static final HyperlinkTypeEnum NONE
      Constant useful for specifying that the element does not contain a hyperlink. This is the default value for a hyperlink type.

    • REFERENCE

      public static final HyperlinkTypeEnum REFERENCE
      Constant useful for specifying that the hyperlink points to an external resource specified by the hyperlink reference expression.
      See Also:

    • LOCAL_ANCHOR

      public static final HyperlinkTypeEnum LOCAL_ANCHOR
      Constant useful for specifying that the hyperlink points to a local anchor, specified by the hyperlink anchor expression.
      See Also:

    • LOCAL_PAGE

      public static final HyperlinkTypeEnum LOCAL_PAGE
      Constant useful for specifying that the hyperlink points to a 1 based page index within the current document.

    • REMOTE_ANCHOR

      public static final HyperlinkTypeEnum REMOTE_ANCHOR
      Constant useful for specifying that the hyperlink points to a remote anchor (specified by the hyperlink anchor expression) within an external document (specified by the hyperlink reference expression).
      See Also:

    • REMOTE_PAGE

      public static final HyperlinkTypeEnum REMOTE_PAGE
      Constant useful for specifying that the hyperlink points to a 1 based page index within an external document (specified by the hyperlink reference expression).

    • CUSTOM

      public static final HyperlinkTypeEnum CUSTOM
      Custom hyperlink type.

      The specific type is determined by getLinkType().

  • Method Details

    • values

      public static HyperlinkTypeEnum[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static HyperlinkTypeEnum valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null

    • getName

      public String getName()
      Specified by:
      getName in interface NamedEnum

    • getByName

      public static HyperlinkTypeEnum getByName(String name)