org.jowidgets.api.model.item

Interface IItemModel

All Superinterfaces:

IItemModelObservable

All Known Subinterfaces:

IActionItemModel, ICheckedItemModel, IContainerItemModel, IMenuItemModel, IMenuModel, IPopupActionItemModel, IRadioItemModel, ISelectableItemModel, ISelectableMenuItemModel, ISeparatorItemModel, IToolBarItemModel

All Known Implementing Classes:

ActionItemModel, CheckedItemModel, ContainerItemModel, InputControlItemModel, MenuModel, PopupActionItemModel, RadioItemModel, SeparatorItemModel

public interface IItemModel
extends IItemModelObservable

Method Summary

Methods

Modifier and Type	Method and Description
IItemModel	createCopy() Creates a deep copy of the item and its children.
Accelerator	getAccelerator() Gets the key accelerator that should be used for the item
IImageConstant	getIcon() Gets the items icon
java.lang.String	getId() Gets the id of the item
java.lang.Character	getMnemonic() Gets the mnemonic character
java.lang.String	getText() Gets the items label text
java.lang.String	getToolTipText() Gets the tooltip text of the item
boolean	isEnabled() Gets the enabled state of the item Remark: Not all bound items may support to become disabled
boolean	isVisible() Gets the visible state of the item
void	setAccelerator(Accelerator accelerator) Sets the key accelerator that should be used for the item
void	setAccelerator(VirtualKey key, Modifier... modifier) Sets the key accelerator that should be used for the item
void	setEnabled(boolean enabled) Sets the enabled state of the item.
void	setIcon(IImageConstant icon) Sets the items icon
void	setMnemonic(char mnemonic) Sets the mnemonic character
void	setMnemonic(java.lang.Character mnemonic) Sets the mnemonic character
void	setText(java.lang.String text) Sets the items label text
void	setToolTipText(java.lang.String toolTipText) Sets the tooltip text for the item
void	setVisible(boolean visible) Sets the visible state of an item Items that was set invisible will be hidden in their container

Methods inherited from interface org.jowidgets.api.model.item.IItemModelObservable

addItemModelListener, removeItemModelListener

Method Detail

getId

java.lang.String getId()

Gets the id of the item

Returns:

The id of the item, never null

setText

void setText(java.lang.String text)

Sets the items label text

Parameters:

text - The label text of the item, may be null

getText

java.lang.String getText()

Gets the items label text

Returns:

The label text of the item, may be null

setToolTipText

void setToolTipText(java.lang.String toolTipText)

Sets the tooltip text for the item

Parameters:

toolTipText - The tooltip text to set, may be null

getToolTipText

java.lang.String getToolTipText()

Gets the tooltip text of the item

Returns:

The tooltip text, may be null

setIcon

void setIcon(IImageConstant icon)

Sets the items icon

Parameters:

icon - The icon to set, may be null

getIcon

IImageConstant getIcon()

Gets the items icon

Returns:

The icon, may be null

setAccelerator

void setAccelerator(Accelerator accelerator)

Sets the key accelerator that should be used for the item

Parameters:

accelerator - The accelerator to set, may be null

setAccelerator

void setAccelerator(VirtualKey key,
                  Modifier... modifier)

Sets the key accelerator that should be used for the item

Parameters:

key - The character to use

modifier - The modifier to use

getAccelerator

Accelerator getAccelerator()

Gets the key accelerator that should be used for the item

Returns:

The key accelerator, may be null

setMnemonic

void setMnemonic(java.lang.Character mnemonic)

Sets the mnemonic character

Parameters:

mnemonic - The mnemonic character to set, may be null

setMnemonic

void setMnemonic(char mnemonic)

Sets the mnemonic character

Parameters:

mnemonic - The mnemonic character to set

getMnemonic

java.lang.Character getMnemonic()

Gets the mnemonic character

Returns:

The mnemonic character, may be null

setEnabled

void setEnabled(boolean enabled)

Sets the enabled state of the item. Remark: Not all bound items may support to become disabled

Parameters:

enabled - The enabled state to set

isEnabled

boolean isEnabled()

Gets the enabled state of the item Remark: Not all bound items may support to become disabled

Returns:

true if enabled, false otherwise

setVisible

void setVisible(boolean visible)

Sets the visible state of an item Items that was set invisible will be hidden in their container

Parameters:

visible - The visible state to set

isVisible

boolean isVisible()

Gets the visible state of the item

Returns:

True if visible, false otherwise

createCopy

IItemModel createCopy()

Creates a deep copy of the item and its children. Remark: Registered listeners on items won't be copied, so the result has no registered listeners for the first time.

Returns:

A new instance that is a clone of this instance