Package su.onno.ui

Record Class ActionSpec.Action

java.lang.Object
java.lang.Record
su.onno.ui.ActionSpec.Action
Enclosing class:
ActionSpec
public static record ActionSpec.Action(String key, String label, String icon, String logo, String color, ActionScope scope, String menu, String navigateUrl, Function<ActionContext,ActionResult> handler, Function<ActionRow,String> iconFn, Function<ActionRow,String> labelFn, Predicate<ActionRow> visibleFn, Predicate<ActionRow> enabledFn, List<InputSpec.InputField> form, List<InputSpec.InputGroup> formGroups, InputSpec.ActionFormDialog formDialog, Function<ActionContext,ActionSpec.FormDefaults> formDefaultsFn, List<String> roles) extends Record
A resolved action button. Exactly one of navigateUrl / handler is set.

icon/label are the fixed values (and the fallback). logo is an optional image URL/path shown in place of the lucide icon — a brand mark ("Connect with X"), rendered on page-action and list/row/toolbar buttons. color is an optional presentation hint for compact menu swatches such as status choices. iconFn, labelFn, visibleFn and enabledFn are the optional per-record overrides for a ActionScope.ROW or ActionScope.DETAIL action — any that are non-null are evaluated against the ActionRow (a list row, or the loaded detail record) as the surface renders.

  • Constructor Details

    • Action

      public Action(String key, String label, String icon, String logo, String color, ActionScope scope, String menu, String navigateUrl, Function<ActionContext,ActionResult> handler, Function<ActionRow,String> iconFn, Function<ActionRow,String> labelFn, Predicate<ActionRow> visibleFn, Predicate<ActionRow> enabledFn, List<InputSpec.InputField> form, List<InputSpec.InputGroup> formGroups, InputSpec.ActionFormDialog formDialog, Function<ActionContext,ActionSpec.FormDefaults> formDefaultsFn, List<String> roles)
      Creates an instance of a Action record class.
      Parameters:
      key - the value for the key record component
      label - the value for the label record component
      icon - the value for the icon record component
      logo - the value for the logo record component
      color - the value for the color record component
      scope - the value for the scope record component
      menu - the value for the menu record component
      navigateUrl - the value for the navigateUrl record component
      handler - the value for the handler record component
      iconFn - the value for the iconFn record component
      labelFn - the value for the labelFn record component
      visibleFn - the value for the visibleFn record component
      enabledFn - the value for the enabledFn record component
      form - the value for the form record component
      formGroups - the value for the formGroups record component
      formDialog - the value for the formDialog record component
      formDefaultsFn - the value for the formDefaultsFn record component
      roles - the value for the roles record component

  • Method Details

    • isServer

      public boolean isServer()

    • hasForm

      public boolean hasForm()
      Whether clicking must first collect the declared form fields (scalar or row group) in a modal dialog.

    • hasDynamicForm

      public boolean hasDynamicForm()
      Whether the form's opening values are computed server-side per open (formDefaults).

    • isDynamic

      public boolean isDynamic()
      Whether any aspect of this action varies per row (so the list must resolve it per row).

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • key

      public String key()
      Returns the value of the key record component.
      Returns:
      the value of the key record component

    • label

      public String label()
      Returns the value of the label record component.
      Returns:
      the value of the label record component

    • icon

      public String icon()
      Returns the value of the icon record component.
      Returns:
      the value of the icon record component

    • logo

      public String logo()
      Returns the value of the logo record component.
      Returns:
      the value of the logo record component

    • color

      public String color()
      Returns the value of the color record component.
      Returns:
      the value of the color record component

    • scope

      public ActionScope scope()
      Returns the value of the scope record component.
      Returns:
      the value of the scope record component

    • handler

      public Function<ActionContext,ActionResult> handler()
      Returns the value of the handler record component.
      Returns:
      the value of the handler record component

    • iconFn

      public Function<ActionRow,String> iconFn()
      Returns the value of the iconFn record component.
      Returns:
      the value of the iconFn record component

    • labelFn

      public Function<ActionRow,String> labelFn()
      Returns the value of the labelFn record component.
      Returns:
      the value of the labelFn record component

    • visibleFn

      public Predicate<ActionRow> visibleFn()
      Returns the value of the visibleFn record component.
      Returns:
      the value of the visibleFn record component

    • enabledFn

      public Predicate<ActionRow> enabledFn()
      Returns the value of the enabledFn record component.
      Returns:
      the value of the enabledFn record component

    • form

      public List<InputSpec.InputField> form()
      Returns the value of the form record component.
      Returns:
      the value of the form record component

    • formGroups

      public List<InputSpec.InputGroup> formGroups()
      Returns the value of the formGroups record component.
      Returns:
      the value of the formGroups record component

    • formDialog

      public InputSpec.ActionFormDialog formDialog()
      Returns the value of the formDialog record component.
      Returns:
      the value of the formDialog record component

    • formDefaultsFn

      public Function<ActionContext,ActionSpec.FormDefaults> formDefaultsFn()
      Returns the value of the formDefaultsFn record component.
      Returns:
      the value of the formDefaultsFn record component

    • roles

      public List<String> roles()
      Returns the value of the roles record component.
      Returns:
      the value of the roles record component