public abstract class AbstractButton extends Object implements Comparable
Modifier and Type | Field and Description |
---|---|
static String |
BOOKMARKS_TOOLBAR
Toolbar name for bookmarks
|
static String |
BUTTON_HIDDEN
The state of a button which is hidden
|
static String |
BUTTON_IN
The state of a button which is visible and depressed
|
static String |
BUTTON_OUT
The state of a button which is visible but not depressed
|
static String |
CONTENT_TOOLBAR
Toolbar name for the content pane, which shows help pages
|
static String |
INDEX_TOOLBAR
Toolbar name for the keyword index
|
static String |
SEARCH_TOOLBAR
Toolbar name for search results
|
static String |
TOC_TOOLBAR
Toolbar name for the table of contents
|
Constructor and Description |
---|
AbstractButton() |
Modifier and Type | Method and Description |
---|---|
int |
compareTo(Object o) |
abstract String |
getAction()
a JavaScript function which will be called when the button is pressed
|
abstract String |
getId()
Gets the id which will be assigned to the image of the button in the
generated HTML
|
abstract String |
getImageURL() |
String |
getJavaScriptURL()
Get the location of the a javascript file to be included in any
jsp file which uses this button
|
String |
getState()
Get the state of a button
|
abstract String |
getTooltip(Locale locale)
A user visible description of the button which will appear in the tooltip
|
boolean |
isAddedToToolbar(String toolbarName)
Determines whether this button should be true if the button should be added
to particular toolbar
|
public static final String BUTTON_OUT
public static final String BUTTON_IN
public static final String BUTTON_HIDDEN
public static final String CONTENT_TOOLBAR
public static final String TOC_TOOLBAR
public static final String INDEX_TOOLBAR
public static final String SEARCH_TOOLBAR
public static final String BOOKMARKS_TOOLBAR
public abstract String getId()
public abstract String getImageURL()
public abstract String getTooltip(Locale locale)
locale
- the locale of the clientpublic abstract String getAction()
public String getState()
BUTTON_OUT
, BUTTON_IN
, or
BUTTON_HIDDEN
.public String getJavaScriptURL()
null
if there.public boolean isAddedToToolbar(String toolbarName)
toolbarName
- public final int compareTo(Object o)
compareTo
in interface Comparable
Copyright (c) 2000, 2014 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.