Package ca.corbett.extras.actionpanel

Class BorderOptions

java.lang.Object
ca.corbett.extras.actionpanel.ActionPanelOptions
ca.corbett.extras.actionpanel.BorderOptions
public class BorderOptions extends ActionPanelOptions
Encapsulates all border-related options for an ActionPanel. In addition to setting a border around the ActionPanel itself, which can be done through the usual means, the following additional border options are supported for the action groups within the ActionPanel:
  • Group border - extends around the entire action group.
  • Header border - extends around the header section of an action group.
  • Action tray border - extends around the action portion of an action group. That is, not including the header at the top, or the toolbar at the bottom. The middle section only.
  • ToolBar border - extends around the ToolBar section of an action group.

The above options are set once, and apply to all action groups within an ActionPanel. It is not currently possible to have different borders per action group.

The above options can be set independently, or can be used in any combination.

Since:
swing-extras 2.8
Author:
scorbo2

  • Method Details

    • setGroupBorder

      public BorderOptions setGroupBorder(Border border)
      Sets a border that will extend around the entire action group (all sections).
      Parameters:
      border - The border to use, or null for no border.
      Returns:
      This BorderOptions instance, for method chaining.

    • getGroupBorder

      public Border getGroupBorder()
      Returns the group border, or null if no border is set.
      Returns:
      A Border to use for action groups, or null for no border.

    • setHeaderBorder

      public BorderOptions setHeaderBorder(Border border)
      Sets the border for action group headers. The header is the top section containing the group name and expand/collapse button, not including the action tray or toolbar below it.
      Parameters:
      border - The border to use, or null for no border.
      Returns:
      This BorderOptions instance, for method chaining.

    • getHeaderBorder

      public Border getHeaderBorder()
      Returns the border for action group headers, or null if no border is set.
      Returns:
      A Border to use for group headers, or null for no border.

    • setActionTrayBorder

      public BorderOptions setActionTrayBorder(Border border)
      Sets the border for the action tray section of action groups. The action tray is the middle section of an action group, not including the header at the top, or the toolbar at the bottom.
      Parameters:
      border - The border to use, or null for no border.
      Returns:
      This BorderOptions instance, for method chaining.

    • getActionTrayBorder

      public Border getActionTrayBorder()
      Returns the border for the action tray section of action groups, or null if no border is set.
      Returns:
      A Border to use for the action tray section of action groups, or null for no border.

    • setToolBarBorder

      public BorderOptions setToolBarBorder(Border border)
      Sets the border for the ToolBar section of action groups. The ToolBar is the bottom section of an action group, not including the header at the top, or the action tray in the middle.
      Parameters:
      border - The border to use, or null for no border.
      Returns:
      This BorderOptions instance, for method chaining.

    • getToolBarBorder

      public Border getToolBarBorder()
      Returns the border for the ToolBar section of action groups, or null if no border is set.
      Returns:
      A Border to use for the ToolBar section of action groups, or null for no border.