Package org.broadleafcommerce.common.presentation

Annotation Interface AdminGroupPresentation

@Retention(RUNTIME) @Target(TYPE) public @interface AdminGroupPresentation
Author:
ckittrell

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    boolean
    collapsed
    Optional - only required if you want to control the initial collapsed state of the group
    int
    column
    Optional - only required if you want to place a group in a column other than the "main" column
    String
    name
    Specify a GUI group name
    int
    order
    Optional - only required if you want to order the appearance of groups in the UI
    String
    tooltip
    Optional - only required if you want to provide help text for this group
    boolean
    untitled
    Optional - only required if you want to remove the group's border

  • Element Details

    • name

      String name
      Specify a GUI group name
      Returns:
      the group name
      Default:
      "General"

    • order

      int order
      Optional - only required if you want to order the appearance of groups in the UI

      Specify an order for this group. Groups will be sorted in the resulting form in ascending order based on this parameter.

      Returns:
      the order for this group
      Default:
      99999

    • column

      int column
      Optional - only required if you want to place a group in a column other than the "main" column

      Specify which column that the group should be placed into. By default, groups are placed in the "main" column (0). To place in the right-side ("sidebar") column, set column to 1.

      Returns:
      the containing column of the group
      Default:
      0

    • untitled

      boolean untitled
      Optional - only required if you want to remove the group's border

      This only applies to groups that are in the "main" column.

      Returns:
      whether or not the group is untitled
      Default:
      false

    • tooltip

      String tooltip
      Optional - only required if you want to provide help text for this group

      On the form for this entity, this will show a question mark icon next to the group title. When the user hovers on the icon, whatever HTML that is specified in this helpText is shown in a popup.

      For i18n support, this can also be a key to a localized version of the text

      Reference implementation: http://www.smartclient.com/smartgwt/showcase/#form_details_hints

      Default:
      ""

    • collapsed

      boolean collapsed
      Optional - only required if you want to control the initial collapsed state of the group

      Specify whether a group is collapsed by default in the admin UI.

      Returns:
      whether or not the group is collapsed by default
      Default:
      false