Class FixedButtonFactory

All Implemented Interfaces:
DynamicActionAttributes, ButtonAction, Action, ActionFactory<ButtonAction>

public class FixedButtonFactory
extends AbstractJspActionFactory<ButtonAction>
implements ButtonAction
A simple implementation of a toolbar button action factory that creates the same fixed button for all users not using any context information.

The button is by default both visible and enabled. Use the setter method to change the properties. Changes to the properties are immediately visible in the menu items returned from the getActions(InvokationContext) method.

If the extension point supports scripts and stylesheets, use the AbstractJspFactory.setScript(String) and AbstractJspFactory.setStylesheet(String) methods. Each call to these methods will add the argument to a set. Use the AbstractJspFactory.getScripts() and AbstractJspFactory.getStylesheets() methods to gain access to the sets, for example, to remove added items.

Last modified
$Date:2008-03-20 12:15:25 +0100 (Thu, 20 Mar 2008) $
  • Field Details

    • actions

      private ButtonAction[] actions
    • id

      private String id
    • clazz

      private String clazz
    • icon

      private String icon
    • style

      private String style
    • title

      private String title
    • tooltip

      private String tooltip
    • enabled

      private boolean enabled
    • visible

      private boolean visible
    • tabIndex

      private int tabIndex
  • Constructor Details

    • FixedButtonFactory

      public FixedButtonFactory()
      Create a new factory instance.
  • Method Details

    • getActions

      public ButtonAction[] getActions​(InvokationContext<? super ButtonAction> context)
      Description copied from interface: ActionFactory
      This method may be called one or several times for each request. This is decided by the extension point. If, for example, the extension point is a pure single-item extension point then this method is probably only called once. If the extension point is a per-item extension point in a list context, then this method may be called once for every item in the list. The context parameter contains all information about the context of the extension point, including the current item, if any.
      Specified by:
      getActions in interface ActionFactory<ButtonAction>
      context - The current invokation context
      An array of actions that should be added to the extension point. Returns null or an empty array if there are no actions in the current context.
    • getClazz

      public String getClazz()
      Description copied from interface: ButtonAction
      Class attribute of the main button tag. The default value is "button".
      Specified by:
      getClazz in interface ButtonAction
      Class attribute, or null to use the default "button"
    • getId

      public String getId()
      Description copied from interface: ButtonAction
      ID attribute of the main button tag. You need to set this value to reference the button in a javascript.
      Specified by:
      getId in interface ButtonAction
      The ID, or null
    • getIcon

      public String getIcon()
      Description copied from interface: ButtonAction
      Get a reference to an image that will be displayed in the menu. It is recommended that the image is 16x16 pixels to line up with the other icons used by the BASE.
      Specified by:
      getIcon in interface ButtonAction
      A reference to an image, or null if no image should be used
    • getStyle

      public String getStyle()
      Description copied from interface: ButtonAction
      Extra CSS style attributes that will be added to the style attribute of the main button tag.
      Specified by:
      getStyle in interface ButtonAction
      Style attributes, or null
    • getTitle

      public String getTitle()
      Description copied from interface: ButtonAction
      Get the title of the button.
      Specified by:
      getTitle in interface ButtonAction
    • getTooltip

      public String getTooltip()
      Description copied from interface: ButtonAction
      A tooltip that is shown as a yellow popup when the user points the mouse at the button.
      Specified by:
      getTooltip in interface ButtonAction
      The tooltip or null to not display any tooltip
    • isEnabled

      public boolean isEnabled()
      Description copied from interface: ButtonAction
      If the button should be enabled or disabled.
      Specified by:
      isEnabled in interface ButtonAction
    • isVisible

      public boolean isVisible()
      Description copied from interface: ButtonAction
      If the button should be visible or not.
      Specified by:
      isVisible in interface ButtonAction
    • getTabIndex

      public int getTabIndex()
      Description copied from interface: ButtonAction
      Get the tab index used to control focus order when tabbing. Use -1 to disable.
      Specified by:
      getTabIndex in interface ButtonAction
    • setClazz

      public void setClazz​(String clazz)
    • setIcon

      @VariableSetter @PathSetter public void setIcon​(String icon)
    • setId

      public void setId​(String id)
    • setStyle

      public void setStyle​(String style)
    • setTitle

      public void setTitle​(String title)
    • setTooltip

      public void setTooltip​(String tooltip)
    • setEnabled

      public void setEnabled​(boolean enabled)
    • setEnabled

      public void setEnabled​(String enabled)
    • setVisible

      public void setVisible​(boolean visible)
    • setVisible

      public void setVisible​(String visible)
    • setTabIndex

      public void setTabIndex​(int tabIndex)