Package com.motivewave.platform.sdk.common.desc

Class SettingGroup

java.lang.Object
com.motivewave.platform.sdk.common.desc.SettingGroup
public class SettingGroup extends Object
Identifies a set of inputs that are to be arranged as a group when displaying the configuration dialog to the end user. The input group consists of a series of row. By default each input element is placed on a separate row (in the order in which they are given). To place more than one element on the same row, pass multiple setting descriptors to the addRow method.

  • Constructor Details

    • SettingGroup

      public SettingGroup(String name)
      Creates a SettingGroup with the given name.

    • SettingGroup

      public SettingGroup(String name, boolean gridLayout)
      Creates a SettingGroup with the given name and grid layout setting.

  • Method Details

    • getName

      public String getName()
      Returns:
      the name of the group (displayed in the Study Dialog.

    • addRow

      public void addRow(SettingDescriptor... row)
      Adds a row with 1 or more inputs.

    • getRows

      public List<SettingDescriptor[]> getRows()
      Gets the rows in this group (each row may contain 1 or more inputs)

    • isGridLayout

      public boolean isGridLayout()
      Determines if a grid layout (default true) should be used instead of a label/horizontal box layout should be used
      Returns:
      true if a grid layout is used for the form (default true)

    • setGridLayout

      public void setGridLayout(boolean b)
      Sets the grid layout attribute for the form.
      Parameters:
      b - true if grid layout should be used