FixedButtonFactory (BASE 2.17.2 API documentation)

Overview

Package

Class

Tree

Deprecated

Index

Help

2.17.2: 2011-06-17

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

net.sf.basedb.clients.web.extensions.toolbar
Class FixedButtonFactory

java.lang.Object
  net.sf.basedb.clients.web.extensions.AbstractJspFactory
      net.sf.basedb.clients.web.extensions.AbstractJspActionFactory<ButtonAction>
          net.sf.basedb.clients.web.extensions.toolbar.FixedButtonFactory

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

public class FixedButtonFactory
extends AbstractJspActionFactory<ButtonAction>
implements ButtonAction
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.

Version:: 2.7
Author:: nicklas
Last modified: $Date:2008-03-20 12:15:25 +0100 (Thu, 20 Mar 2008) $

Field Summary
`private ButtonAction[]`	`actions`
`private String`	`clazz`
`private boolean`	`enabled`
`private String`	`icon`
`private String`	`id`
`private String`	`onClick`
`private String`	`style`
`private String`	`title`
`private String`	`tooltip`
`private boolean`	`visible`

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

Method Summary
`ButtonAction[]`	`getActions(InvokationContext context)` This method may be called one or several times for each request.
`String`	`getClazz()` Class attribute of the main button tag.
`String`	`getIcon()` Get a reference to an image that will be displayed in the menu.
`String`	`getId()` ID attribute of the main button tag.
`String`	`getOnClick()` A javascript action that is executed when the user clicks on the button.
`String`	`getStyle()` Extra CSS style attributes that will be added to the `style` attribute of the main button tag.
`String`	`getTitle()` Get the title of the button.
`String`	`getTooltip()` A tooltip that is shown as a yellow popup when the user points the mouse at the button.
`boolean`	`isEnabled()` If the button should be enabled or disabled.
`boolean`	`isVisible()` If the button should be visible or not.
`void`	`setClazz(String clazz)`
`void`	`setEnabled(boolean enabled)`
`void`	`setEnabled(String enabled)`
`void`	`setIcon(String icon)`
`void`	`setId(String id)`
`void`	`setOnClick(String onClick)`
`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 ButtonAction[] actions

id

private String id

clazz

private String clazz

icon

private String icon

onClick

private String onClick

style

private String style

title

private String title

tooltip

private String tooltip

enabled

private boolean enabled

visible

private boolean visible

Constructor Detail

FixedButtonFactory

public FixedButtonFactory()

Create a new factory instance.

Method Detail

getActions

public ButtonAction[] 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<ButtonAction>

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.