org.gudy.azureus2.plugins.ui.toolbar
Interface UIToolBarItem

All Known Subinterfaces:

ToolBarItem

All Known Implementing Classes:

UIToolBarItemImpl

public interface UIToolBarItem

Field Summary

static long	STATE_DOWN
static long	STATE_ENABLED

Method Summary

java.lang.String	getGroupID()
java.lang.String	getID() Retrieve the ID of the toolbar item
java.lang.String	getImageID() Get the ID of the image used
long	getState()
java.lang.String	getTextID() Return the message bundle ID for the button text
java.lang.String	getToolTip()
boolean	isAlwaysAvailable() Returns if the toolbar item is always available (enabled)
void	setDefaultActivationListener(UIToolBarActivationListener defaultActivation)
void	setGroupID(java.lang.String groupID)
void	setImageID(java.lang.String id) Sets the toolbar item to use the specified image
void	setState(long state)
void	setTextID(java.lang.String id) Sets the button's text to a messagebundle value looked up using the id
void	setToolTip(java.lang.String text)
boolean	triggerToolBarItem(long activationType, java.lang.Object datasource)

Field Detail

STATE_ENABLED

static final long STATE_ENABLED

See Also:

Constant Field Values

STATE_DOWN

static final long STATE_DOWN

See Also:

Constant Field Values

Method Detail

getID

java.lang.String getID()

Retrieve the ID of the toolbar item

Since:

4.6.0.5

getTextID

java.lang.String getTextID()

Return the message bundle ID for the button text

Since:

4.6.0.5

setTextID

void setTextID(java.lang.String id)

Sets the button's text to a messagebundle value looked up using the id

Parameters:

id -

Since:

4.6.0.5

getImageID

java.lang.String getImageID()

Get the ID of the image used

Since:

4.6.0.5

setImageID

void setImageID(java.lang.String id)

Sets the toolbar item to use the specified image

Since:

4.6.0.5

isAlwaysAvailable

boolean isAlwaysAvailable()

Returns if the toolbar item is always available (enabled)

Since:

4.6.0.5

getState

long getState()

setState

void setState(long state)

triggerToolBarItem

boolean triggerToolBarItem(long activationType,
                           java.lang.Object datasource)

setDefaultActivationListener

void setDefaultActivationListener(UIToolBarActivationListener defaultActivation)

getGroupID

java.lang.String getGroupID()

Returns:

Group that item belongs to

Since:

5.0.0.1

setGroupID

void setGroupID(java.lang.String groupID)

Parameters:

groupID -

Since:

5.0.0.1

setToolTip

void setToolTip(java.lang.String text)

Parameters:

string -

Since:

5.0.0.1

getToolTip

java.lang.String getToolTip()

Returns:

Since:

5.0.0.1