Class IncludeContentTabFactory

All Implemented Interfaces:
DynamicActionAttributes, ActionFactory<TabAction>

public class IncludeContentTabFactory extends AbstractJspActionFactory<TabAction>
A tab action factory implementation that includes another resource as the content of tab. The other resource can be a JSP script, servlet, a static file, or anything else that makes sense.

The current JspContext is stored as a ServletRequest attribute with key JspContext.ATTRIBUTE_KEY. If the included page is a JSP page it can get the JspContext by calling request.getAttribute(JspContext.ATTRIBUTE_KEY).

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

    • 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
    • include

      private String include
    • tabIndex

      private int tabIndex
  • Constructor Details

    • IncludeContentTabFactory

      public IncludeContentTabFactory()
      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.
      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.
    • 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)
    • setTabIndex

      public void setTabIndex(String tabIndex)
    • setInclude

      @PathSetter(pathType=CONTEXT_RELATIVE) public void setInclude(String include)