Package net.sf.basedb.clients.web.extensions.tabcontrol

Class FixedTabFactory

java.lang.Object
net.sf.basedb.clients.web.extensions.AbstractJspFactory
net.sf.basedb.clients.web.extensions.AbstractJspActionFactory<TabAction>
net.sf.basedb.clients.web.extensions.tabcontrol.FixedTabFactory
All Implemented Interfaces:
DynamicActionAttributes, TabAction, Action, ActionFactory<TabAction>
public class FixedTabFactory extends AbstractJspActionFactory<TabAction> implements TabAction
A simple implementation of a tab action factory that creates the same fixed tab for all users not using any context information.

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.

Since:
2.17
Author:
nicklas
Last modified
$Date: 2015-04-20 11:08:18 +0200 (må, 20 apr 2015) $

  • Field Details

    • actions

      private TabAction[] actions

    • id

      private String id

    • clazz

      private String clazz

    • style

      private String style

    • title

      private String title

    • tooltip

      private String tooltip

    • helpId

      private String helpId

    • visible

      private boolean visible

    • content

      private String content

    • tabIndex

      private int tabIndex

  • Constructor Details

    • FixedTabFactory

      public FixedTabFactory()
      Create a new factory instance.

  • Method Details

    • getActions

      public TabAction[] getActions(InvokationContext<? super TabAction> 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<TabAction>
      Parameters:
      context - The current invokation context
      Returns:
      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.

    • getId

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

    • getClazz

      public String getClazz()
      Description copied from interface: TabAction
      Class attribute of the main tab tag.
      Specified by:
      getClazz in interface TabAction
      Returns:
      Class attribute, or null to not add any class attribute

    • getStyle

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

    • getTitle

      public String getTitle()
      Description copied from interface: TabAction
      Get the title of the tab.
      Specified by:
      getTitle in interface TabAction

    • getTooltip

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

    • isVisible

      public boolean isVisible()
      Description copied from interface: TabAction
      If the tab should be visible or not.
      Specified by:
      isVisible in interface TabAction

    • getHelpId

      public String getHelpId()
      Description copied from interface: TabAction
      The external id of a help text that the user can display to get more information about how to use the information in this tab. See Help.getExternalId().
      Specified by:
      getHelpId in interface TabAction
      Returns:
      The help id or null to not display any help

    • getContent

      public String getContent()
      Description copied from interface: TabAction
      Get the (HTML) contents of the tab.
      Specified by:
      getContent in interface TabAction

    • getTabIndex

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

    • setId

      public void setId(String id)

    • setClazz

      public void setClazz(String clazz)

    • setStyle

      public void setStyle(String style)

    • setTitle

      public void setTitle(String title)

    • setTooltip

      public void setTooltip(String tooltip)

    • setVisible

      public void setVisible(boolean visible)

    • setVisible

      public void setVisible(String visible)

    • setHelpId

      public void setHelpId(String helpId)

    • setContent

      public void setContent(String content)

    • setTabIndex

      public void setTabIndex(String tabIndex)