org.eclipse.help.webapp

Class AbstractButton

java.lang.Object

org.eclipse.help.webapp.AbstractButton

All Implemented Interfaces:

java.lang.Comparable<AbstractButton>

public abstract class AbstractButton
extends java.lang.Object
implements java.lang.Comparable<AbstractButton>

A class which contributes a button to the help webapp

Since:

3.5

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BOOKMARKS_TOOLBAR Toolbar name for bookmarks
static java.lang.String	BUTTON_HIDDEN The state of a button which is hidden
static java.lang.String	BUTTON_IN The state of a button which is visible and depressed
static java.lang.String	BUTTON_OUT The state of a button which is visible but not depressed
static java.lang.String	CONTENT_TOOLBAR Toolbar name for the content pane, which shows help pages
static java.lang.String	INDEX_TOOLBAR Toolbar name for the keyword index
static java.lang.String	SEARCH_TOOLBAR Toolbar name for search results
static java.lang.String	TOC_TOOLBAR Toolbar name for the table of contents

Constructor Summary

Constructors

Constructor and Description
AbstractButton()

Method Summary

Modifier and Type	Method and Description
int	compareTo(AbstractButton o)
abstract java.lang.String	getAction() a JavaScript function which will be called when the button is pressed
abstract java.lang.String	getId() Gets the id which will be assigned to the image of the button in the generated HTML
abstract java.lang.String	getImageURL()
java.lang.String	getJavaScriptURL() Get the location of the a javascript file to be included in any jsp file which uses this button
java.lang.String	getState() Get the state of a button
abstract java.lang.String	getTooltip(java.util.Locale locale) A user visible description of the button which will appear in the tooltip
boolean	isAddedToToolbar(java.lang.String toolbarName) Determines whether this button should be true if the button should be added to particular toolbar

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

BUTTON_OUT

public static final java.lang.String BUTTON_OUT

The state of a button which is visible but not depressed

See Also:

Constant Field Values

BUTTON_IN

public static final java.lang.String BUTTON_IN

The state of a button which is visible and depressed

See Also:

Constant Field Values

BUTTON_HIDDEN

public static final java.lang.String BUTTON_HIDDEN

The state of a button which is hidden

See Also:

Constant Field Values

CONTENT_TOOLBAR

public static final java.lang.String CONTENT_TOOLBAR

Toolbar name for the content pane, which shows help pages

See Also:

Constant Field Values

TOC_TOOLBAR

public static final java.lang.String TOC_TOOLBAR

Toolbar name for the table of contents

See Also:

Constant Field Values

INDEX_TOOLBAR

public static final java.lang.String INDEX_TOOLBAR

Toolbar name for the keyword index

See Also:

Constant Field Values

SEARCH_TOOLBAR

public static final java.lang.String SEARCH_TOOLBAR

Toolbar name for search results

See Also:

Constant Field Values

BOOKMARKS_TOOLBAR

public static final java.lang.String BOOKMARKS_TOOLBAR

Toolbar name for bookmarks

See Also:

Constant Field Values

Constructor Detail

AbstractButton

public AbstractButton()

Method Detail

getId

public abstract java.lang.String getId()

Gets the id which will be assigned to the image of the button in the generated HTML

Returns:

a string that consists of alphanumeric characters only with no spaces

getImageURL

public abstract java.lang.String getImageURL()

Returns:

a URL relative to /help which is the location of the 16x16 image icon which will appear in the tab

getTooltip

public abstract java.lang.String getTooltip(java.util.Locale locale)

A user visible description of the button which will appear in the tooltip

Parameters:

locale - the locale of the client

Returns:

the tooltip text to be used in this locale

getAction

public abstract java.lang.String getAction()

a JavaScript function which will be called when the button is pressed

Returns:

the name of a JavaScript function

getState

public java.lang.String getState()

Get the state of a button

Returns:

one of BUTTON_OUT, BUTTON_IN, or BUTTON_HIDDEN.

getJavaScriptURL

public java.lang.String getJavaScriptURL()

Get the location of the a javascript file to be included in any jsp file which uses this button

Returns:

a URL path, relative to /help or null if there.

isAddedToToolbar

public boolean isAddedToToolbar(java.lang.String toolbarName)

Determines whether this button should be true if the button should be added to particular toolbar

Parameters:

toolbarName -

Returns:

true

compareTo

public final int compareTo(AbstractButton o)

Specified by:

compareTo in interface java.lang.Comparable<AbstractButton>

Since:

3.7