FixedTabFactory (BASE 3.1.1 API documentation)

Overview

Package

Class

Tree

Deprecated

Index

Help

3.1.1: 2012-03-29

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

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:: TabAction, Action, ActionFactory<TabAction>

public class FixedTabFactory
extends AbstractJspActionFactory<TabAction>
implements TabAction
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: 2010-11-10 12:16:51 +0100 (Wed, 10 Nov 2010) $

Field Summary
`private TabAction[]`	`actions`
`private String`	`clazz`
`private String`	`content`
`private String`	`helpId`
`private String`	`id`
`private String`	`onActivate`
`private String`	`onValidate`
`private String`	`style`
`private String`	`title`
`private String`	`tooltip`
`private boolean`	`visible`

Constructor Summary
`FixedTabFactory()` Create a new factory instance.

Method Summary
`TabAction[]`	`getActions(InvokationContext context)` This method may be called one or several times for each request.
`String`	`getClazz()` Class attribute of the main tab tag.
`String`	`getContent()` Get the (HTML) contents of the tab.
`String`	`getHelpId()` 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.
`String`	`getId()` ID attribute of the main tab tag.
`String`	`getOnActivate()` A javascript action that is executed when activating the tab.
`String`	`getOnValidate()` A javascript action that is executed when validating form data on the tab.
`String`	`getStyle()` Extra CSS style attributes that will be added to the `style` attribute of the main tab tag.
`String`	`getTitle()` Get the title of the tab.
`String`	`getTooltip()` A tooltip that is shown as a yellow popup when the user points the mouse at the tab.
`boolean`	`isVisible()` If the tab should be visible or not.
`void`	`setClazz(String clazz)`
`void`	`setContent(String content)`
`void`	`setHelpId(String helpId)`
`void`	`setId(String id)`
`void`	`setOnActivate(String onActivate)`
`void`	`setOnValidate(String onValidate)`
`void`	`setStyle(String style)`
`void`	`setTitle(String title)`
`void`	`setTooltip(String tooltip)`
`void`	`setVisible(boolean visible)`
`void`	`setVisible(String visible)`

Methods inherited from class net.sf.basedb.clients.web.extensions.AbstractJspActionFactory
`prepareContext`

Methods inherited from class net.sf.basedb.clients.web.extensions.AbstractJspFactory
`getScripts, getStylesheets, prepareContext, setScript, setStylesheet`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

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

onValidate

private String onValidate

onActivate

private String onActivate

content

private String content

Constructor Detail

FixedTabFactory

public FixedTabFactory()

Create a new factory instance.

Method Detail

getActions

public TabAction[] getActions(InvokationContext 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.