com.qcadoo.view.api.ribbon

Interface RibbonActionItem

All Known Subinterfaces:

RibbonComboBox, RibbonComboItem

public interface RibbonActionItem

Represents single ribbon item

Since:

0.4.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	RibbonActionItem.Type Type of ribbon item

Method Summary

Modifier and Type	Method and Description
String	getAccesskey() Get identifier of this ribbon item
String	getAction() Get defined item click action
String	getIcon() Get item icon (null if item without icon)
String	getMessage() Returns message connected to this item
String	getName() Get identifier of this ribbon item
String	getScript() Returns script of this ribbon item
RibbonActionItem.Type	getType() Get item type
boolean	isEnabled() Returns true if this item is enabled
void	requestUpdate(boolean shouldBeUpdated) Informs that this item state should be updated
void	setEnabled(boolean enabled) Sets this item state
void	setIcon(String icon) Set item icon (null if item without icon)
void	setMessage(String message) sets message connected to this item

Method Detail

getAccesskey

String getAccesskey()

Get identifier of this ribbon item

Returns:

identifier of this ribbon item

getAction

String getAction()

Get defined item click action

Returns:

defined item click action

getIcon

String getIcon()

Get item icon (null if item without icon)

Returns:

item icon

getMessage

String getMessage()

Returns message connected to this item

Returns:

message connected to this item

getName

String getName()

Get identifier of this ribbon item

Returns:

identifier of this ribbon item

getScript

String getScript()

Returns script of this ribbon item

Returns:

script of this ribbon item

getType

RibbonActionItem.Type getType()

Get item type

Returns:

item type

isEnabled

boolean isEnabled()

Returns true if this item is enabled

Returns:

true if this item is enabled

requestUpdate

void requestUpdate(boolean shouldBeUpdated)

Informs that this item state should be updated

Parameters:

shouldBeUpdated - true if this item state should be updated

setEnabled

void setEnabled(boolean enabled)

Sets this item state

Parameters:

enabled - true when this item should be enabled or false when this item should be disabled

setIcon

void setIcon(String icon)

Set item icon (null if item without icon)

Parameters:

icon - item icon

setMessage

void setMessage(String message)

sets message connected to this item

Parameters:

message - translation key for new message connected to this item