Package org.apache.juneau.console.widgets

Class ModalDef.Step

java.lang.Object
org.apache.juneau.console.widgets.ModalDef.Step
Enclosing class:
ModalDef
@BeanType(properties="id,title,confirmLabel,fields") public static class ModalDef.Step extends Object
One page of a ModalDef.steps wizard: an id, an optional title and confirm-button label, and the typed display fields painted for that page.
Since:
10.0.0

  • Field Details

    • id

      public String id
      The step id, unique within the modal; a script selects a step by it. Must not be blank.

    • title

      public String title
      The dialog title shown while this step is current; omitted from the wire when unset (the modal title stays).

    • confirmLabel

      public String confirmLabel
      The confirm-button label for this step; omitted when unset (the runtime shows Next, or the final label on the last step).

    • fields

      public List<ModalDef.Field> fields
      The typed display fields painted for this step, in display order; omitted from the wire when none are declared.

  • Constructor Details

    • Step

      public Step()

  • Method Details

    • of

      public static ModalDef.Step of(String id)
      Creates a step.
      Parameters:
      id - The step id. Must not be null or blank.
      Returns:
      A new ModalDef.Step.
      Throws:
      IllegalArgumentException - If id is null or blank.

    • title

      public ModalDef.Step title(String value)
      Sets the dialog title shown while this step is current.
      Parameters:
      value - The title. Can be null to unset.
      Returns:
      This object.

    • confirmLabel

      public ModalDef.Step confirmLabel(String value)
      Sets the confirm-button label for this step.
      Parameters:
      value - The label. Can be null to unset.
      Returns:
      This object.

    • field

      public ModalDef.Step field(String label, String value)
      Adds one typed display field to this step.
      Parameters:
      label - The field label. Must not be null or blank.
      value - The field value. Can be null.
      Returns:
      This object.