|
Eclipse Platform Release 3.6 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.help.webapp.AbstractButton
public abstract class AbstractButton
A class which contributes a button to the help webapp
Field Summary | |
---|---|
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 Summary | |
---|---|
AbstractButton()
|
Method Summary | |
---|---|
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 |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
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
Constructor Detail |
---|
public AbstractButton()
Method Detail |
---|
public abstract String getId()
public abstract String getImageURL()
public abstract String getTooltip(Locale locale)
locale
- the locale of the client
public 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
|
Eclipse Platform Release 3.6 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2010. All rights reserved.