Package org.jgrapes.webconsole.base

Enum Class Conlet.RenderMode

java.lang.Object
java.lang.Enum<Conlet.RenderMode>
org.jgrapes.webconsole.base.Conlet.RenderMode
All Implemented Interfaces:
Serializable, Comparable<Conlet.RenderMode>, Constable
Enclosing interface:
Conlet
public static enum Conlet.RenderMode extends Enum<Conlet.RenderMode>
The render modes.

  • Enum Constant Details

    • Preview

      public static final Conlet.RenderMode Preview
      Provide content to display in a card on the overview tab (by firing a RenderConlet event).

    • View

      public static final Conlet.RenderMode View
      Provide content to display in a tab of its own (by firing a RenderConlet event).

    • Edit

      public static final Conlet.RenderMode Edit
      Provide a dialog for modifying a conlet instance’s properties, typically by opening a modal dialog (see OpenModalDialog).

    • Help

      public static final Conlet.RenderMode Help
      Provide help information, typically by opening a modal dialog (see OpenModalDialog) or using a notification (see DisplayNotification).

    • Content

      public static final Conlet.RenderMode Content
      Provide content that is to be embedded in an area of the console page (see AddConletType.addPageContent(String, java.util.Map)) or in some other conlet’s content (see RenderConlet).

      Conlets that want to include another conlet’s “content” must generate an HTML element as container (typically a div or span) with an attribute “data-conlet-type” and classes “conlet conlet-content”. Additional attributes “data-conlet-…” are considered properties of the conlet instance to be added and are passed to the server with the AddConletRequest.

      Property “id” may be used if already known, but is usually assigned later by the component implementation when the component is rendered. Property “state” is reserved. Its value is provided by the console. The handler for AddConletRequest should pass the value of “state” back as attribute data-conlet-state of the root (or first) element of the content. This allows the console to match the content provided with the conlet content container that caused the request.

    • StickyPreview

      public static final Conlet.RenderMode StickyPreview
      Modifier, indicates that a Preview may not be removed.

    • Foreground

      public static final Conlet.RenderMode Foreground
      Modifier, forces rendered view to be put in foreground.

  • Field Details

  • Method Details

    • values

      public static Conlet.RenderMode[] 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 Conlet.RenderMode 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

    • asSet

      public static Set<Conlet.RenderMode> asSet(Conlet.RenderMode... modes)
      Utility method that creates a Set of render modes from enumerated values.
      Parameters:
      modes - the modes
      Returns:
      the sets the

    • modifiers

      public static Set<Conlet.RenderMode> modifiers(Set<Conlet.RenderMode> modes)
      Retrieves the modifiers.

    • addModifiers

      public Set<Conlet.RenderMode> addModifiers(Set<Conlet.RenderMode> modifiers)
      Adds the modifiers from the given set to this basic mode.
      Parameters:
      modifiers - the set with modifiers
      Returns:
      the augmented basic mode