Package org.zkoss.bind.annotation

Enum Class Scope

java.lang.Object
java.lang.Enum<Scope>
org.zkoss.bind.annotation.Scope
All Implemented Interfaces:
Serializable, Comparable<Scope>, Constable
public enum Scope extends Enum<Scope>
The implicit scopes of zk for ScopeParam.
The AUTO scope means searching the value from components to page, desktop one bye one automatically...until find a value SESSION, APPLICATION and by the order.
Other scope only represents itself.
Since:
6.0.0
Author:
dennis
See Also:

  • Enum Constant Details

    • AUTO

      public static final Scope AUTO
      Search the value from components to page, desktop one bye one...until find a value

    • COMPONENT

      public static final Scope COMPONENT
      Search the value from the implicit componentScope

    • SPACE

      public static final Scope SPACE
      Search the value from the implicit spaceScope

    • PAGE

      public static final Scope PAGE
      Search the value from the implicit pageScope

    • DESKTOP

      public static final Scope DESKTOP
      Search the value from the implicit desktopScope

    • SESSION

      public static final Scope SESSION
      Search the value from the implicit sessionScope

    • APPLICATION

      public static final Scope APPLICATION
      Search the value from the implicit applicationScope

    • EXECUTION

      public static final Scope EXECUTION
      Search the value from the implicit executionScope
      Since:
      8.6.0

  • Method Details

    • values

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

    • valueOf

      public static Scope valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name
      NullPointerException - if the argument is null

    • getName

      public String getName()
      the zk implicit scope name