org.jowidgets.tools.model.item

Class MenuModel

java.lang.Object

org.jowidgets.tools.model.item.MenuModel

All Implemented Interfaces:

IListModelObservable, IItemModel, IItemModelObservable, IMenuItemModel, IMenuModel, IToolBarItemModel, IWrapper<IItemModel>

public class MenuModel
extends java.lang.Object
implements IMenuModel

Constructor Summary

Constructors

Constructor and Description
MenuModel() Creates a new menu model
MenuModel(IMenuModelBuilder builder) Creates a new menu model defined by a builder
MenuModel(java.lang.String text) Creates a new menu model
MenuModel(java.lang.String text, IImageConstant icon) Creates a new menu model
MenuModel(java.lang.String text, java.lang.String toolTipText) Creates a new menu model
MenuModel(java.lang.String text, java.lang.String toolTipText, IImageConstant icon) Creates a nwe menu model
MenuModel(java.lang.String id, java.lang.String text, java.lang.String toolTipText, IImageConstant icon) Creates a nwe menu model

Method Summary

Methods

Modifier and Type	Method and Description
IActionItemModel	addAction(IAction action) Creates an adds an action item and binds it to the given action
IActionItemModel	addAction(int index, IAction action) Creates an adds an action item at a given index and binds it to the given action
IActionItemModel	addActionItem() Creates and adds a action item
IActionItemModel	addActionItem(java.lang.String text) Creates and adds a action item
IActionItemModel	addActionItem(java.lang.String text, IImageConstant icon) Creates and adds a action item
IActionItemModel	addActionItem(java.lang.String text, java.lang.String toolTipText) Creates and adds a action item
IActionItemModel	addActionItem(java.lang.String text, java.lang.String toolTipText, IImageConstant icon) Creates and adds a action item
void	addAfter(IMenuItemModel newItem, java.lang.String... idPath) Adds an item after another item defined by an path of item id If the given path not exists, an IllegalArgumentException will be thrown
void	addBefore(IMenuItemModel newItem, java.lang.String... idPath) Adds an item before another item defined by an path of item id If the given path not exists, an IllegalArgumentException will be thrown
ICheckedItemModel	addCheckedItem() Creates and adds a checked item
ICheckedItemModel	addCheckedItem(java.lang.String text) Creates and adds a checked item
ICheckedItemModel	addCheckedItem(java.lang.String text, IImageConstant icon) Creates and adds a checked item
ICheckedItemModel	addCheckedItem(java.lang.String text, java.lang.String toolTipText) Creates and adds a checked item
ICheckedItemModel	addCheckedItem(java.lang.String text, java.lang.String toolTipText, IImageConstant icon) Creates and adds a checked item
void	addDecorator(IDecorator<IAction> decorator) Adds an action decorator for all actions contained in this menu an all sub menus.
<MODEL_TYPE extends IMenuItemModel,BUILDER_TYPE extends IItemModelBuilder<?,MODEL_TYPE>> MODEL_TYPE	addItem(BUILDER_TYPE itemBuilder) Adds an item defined by an builder and returns the build item
void	addItem(IMenuItemModel item) Adds an item to the model
<MODEL_TYPE extends IMenuItemModel,BUILDER_TYPE extends IItemModelBuilder<?,MODEL_TYPE>> MODEL_TYPE	addItem(int index, BUILDER_TYPE itemBuilder) Adds an item at a given index defined by an builder and returns the build item
void	addItem(int index, IMenuItemModel item) Adds an item at a given index
void	addItemModelListener(IItemModelListener listener) Adds a item model listener
void	addItemsOfModel(IMenuModel menuModel) Adds all items of a given model to this model
void	addListModelListener(IListModelListener listener) Adds a list model listener
IMenuModel	addMenu() Creates and add a submenu
IMenuModel	addMenu(java.lang.String text) Creates and add a submenu
IMenuModel	addMenu(java.lang.String text, IImageConstant icon) Creates and add a submenu
IMenuModel	addMenu(java.lang.String text, java.lang.String toolTipText) Creates and add a submenu
IMenuModel	addMenu(java.lang.String text, java.lang.String toolTipText, IImageConstant icon) Creates and add a submenu
IRadioItemModel	addRadioItem() Creates and adds a radio item
IRadioItemModel	addRadioItem(java.lang.String text) Creates and adds a radio item
IRadioItemModel	addRadioItem(java.lang.String text, IImageConstant icon) Creates and adds a radio item
IRadioItemModel	addRadioItem(java.lang.String text, java.lang.String toolTipText) Creates and adds a radio item
IRadioItemModel	addRadioItem(java.lang.String text, java.lang.String toolTipText, IImageConstant icon) Creates and adds a radio item
ISeparatorItemModel	addSeparator() Creates and adds a separator
ISeparatorItemModel	addSeparator(int index) Creates and adds separator at a given index
ISeparatorItemModel	addSeparator(java.lang.String id) Creates and adds a separator
void	bind(IMenuModel model) Binds the given model to this model with the following manner: 1.
static IMenuModelBuilder	builder() Creates a new menu model builder
static IMenuModelBuilder	builder(java.lang.String text) Creates a new menu model builder and set defaults
static IMenuModelBuilder	builder(java.lang.String text, IImageConstant icon) Creates a new menu model builder and set defaults
static IMenuModelBuilder	builder(java.lang.String text, java.lang.String toolTipText) Creates a new menu model builder and set defaults
static IMenuModelBuilder	builder(java.lang.String text, java.lang.String toolTipText, IImageConstant icon) Creates a new menu model builder and set defaults
static IMenuModelBuilder	builder(java.lang.String id, java.lang.String text, java.lang.String toolTipText, IImageConstant icon) Creates a new menu model builder and set defaults
static IMenuModel	create() Creates a new menu model instance
IMenuModel	createCopy() Creates a deep copy of the item and its children.
boolean	equals(java.lang.Object obj)
IMenuItemModel	findItemByPath(java.lang.String... idPath) Searches for an item in this model defined by a given path
Accelerator	getAccelerator() Gets the key accelerator that should be used for the item
java.util.List<IMenuItemModel>	getChildren() Gets a unmodifieable copy of the menus items
IImageConstant	getIcon() Gets the items icon
java.lang.String	getId() Gets the id of the item
protected IMenuModel	getItemModel()
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
int	hashCode()
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	removeAllItems() Removes all items from the menu
void	removeDecorator(IDecorator<IAction> decorator) Removes a decorator for all actions contained in this menu an all sub menus.
void	removeItem(IMenuItemModel item) Removes an item from this menu
void	removeItem(int index) Removes an item at a given index
void	removeItemModelListener(IItemModelListener listener) removes a item model listener
void	removeListModelListener(IListModelListener listener) removes a list model listener
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
void	unbind(IMenuModel model) Unbind the given model.
IItemModel	unwrap()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

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

getAccelerator, getIcon, getId, getMnemonic, getText, getToolTipText, isEnabled, isVisible, setAccelerator, setAccelerator, setEnabled, setIcon, setMnemonic, setMnemonic, setText, setToolTipText, setVisible

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

addItemModelListener, removeItemModelListener

Constructor Detail

MenuModel

public MenuModel()

Creates a new menu model

MenuModel

public MenuModel(java.lang.String text)

Creates a new menu model

Parameters:

text - The label text of the menu model

MenuModel

public MenuModel(java.lang.String text,
         IImageConstant icon)

Creates a new menu model

Parameters:

text - The label text

icon - The icon

MenuModel

public MenuModel(java.lang.String text,
         java.lang.String toolTipText)

Creates a new menu model

Parameters:

text - The label text

toolTipText - The tooltip text

MenuModel

public MenuModel(java.lang.String text,
         java.lang.String toolTipText,
         IImageConstant icon)

Creates a nwe menu model

Parameters:

text - The label text

toolTipText - The tooltip text

icon - The icon

MenuModel

public MenuModel(java.lang.String id,
         java.lang.String text,
         java.lang.String toolTipText,
         IImageConstant icon)

Creates a nwe menu model

Parameters:

id - the id

text - The label text

toolTipText - The tooltip text

icon - The icon

MenuModel

public MenuModel(IMenuModelBuilder builder)

Creates a new menu model defined by a builder

Parameters:

builder - The builder that defines the model

Method Detail

getItemModel

protected IMenuModel getItemModel()

getChildren

public final java.util.List<IMenuItemModel> getChildren()

Description copied from interface: IMenuModel

Gets a unmodifieable copy of the menus items

Specified by:

getChildren in interface IMenuModel

Returns:

The child items, never null but may be empty

findItemByPath

public final IMenuItemModel findItemByPath(java.lang.String... idPath)

Description copied from interface: IMenuModel

Searches for an item in this model defined by a given path

Specified by:

findItemByPath in interface IMenuModel

Parameters:

idPath - The path of the items ids

Returns:

The item if found, null otherwise

addAction

public final IActionItemModel addAction(IAction action)

Description copied from interface: IMenuModel

Creates an adds an action item and binds it to the given action

Specified by:

addAction in interface IMenuModel

Parameters:

action - The action to use

Returns:

The created action item

addAction

public final IActionItemModel addAction(int index,
                         IAction action)

Description copied from interface: IMenuModel

Creates an adds an action item at a given index and binds it to the given action

Specified by:

addAction in interface IMenuModel

Parameters:

index - The index to add the item at

action - The action to use

Returns:

The created action item

addMenu

public final IMenuModel addMenu()

Description copied from interface: IMenuModel

Creates and add a submenu

Specified by:

addMenu in interface IMenuModel

Returns:

The created submenu

addSeparator

public final ISeparatorItemModel addSeparator()

Description copied from interface: IMenuModel

Creates and adds a separator

Specified by:

addSeparator in interface IMenuModel

Returns:

The created item

addSeparator

public final ISeparatorItemModel addSeparator(int index)

Description copied from interface: IMenuModel

Creates and adds separator at a given index

Specified by:

addSeparator in interface IMenuModel

Parameters:

index - The index where to add the separator

Returns:

The created item

addBefore

public final void addBefore(IMenuItemModel newItem,
             java.lang.String... idPath)

Description copied from interface: IMenuModel

Adds an item before another item defined by an path of item id If the given path not exists, an IllegalArgumentException will be thrown

Specified by:

addBefore in interface IMenuModel

Parameters:

newItem - The item to add

idPath - The path where to add the item

addAfter

public final void addAfter(IMenuItemModel newItem,
            java.lang.String... idPath)

Description copied from interface: IMenuModel

Adds an item after another item defined by an path of item id If the given path not exists, an IllegalArgumentException will be thrown

Specified by:

addAfter in interface IMenuModel

Parameters:

newItem - The item to add

idPath - The path where to add the item

addItem

public final void addItem(IMenuItemModel item)

Description copied from interface: IMenuModel

Adds an item to the model

Specified by:

addItem in interface IMenuModel

Parameters:

item - The item to add, must not be null

addItem

public final void addItem(int index,
           IMenuItemModel item)

Description copied from interface: IMenuModel

Adds an item at a given index

Specified by:

addItem in interface IMenuModel

Parameters:

index - The index to add the item at

item - The item to add

addItem

public final <MODEL_TYPE extends IMenuItemModel,BUILDER_TYPE extends IItemModelBuilder<?,MODEL_TYPE>> MODEL_TYPE addItem(BUILDER_TYPE itemBuilder)

Description copied from interface: IMenuModel

Adds an item defined by an builder and returns the build item

Specified by:

addItem in interface IMenuModel

Parameters:

itemBuilder - The builder that defines the item

Returns:

The added item

addItem

public final <MODEL_TYPE extends IMenuItemModel,BUILDER_TYPE extends IItemModelBuilder<?,MODEL_TYPE>> MODEL_TYPE addItem(int index,
                                                                                                          BUILDER_TYPE itemBuilder)

Description copied from interface: IMenuModel

Adds an item at a given index defined by an builder and returns the build item

Specified by:

addItem in interface IMenuModel

Parameters:

index - The index to add the item at

itemBuilder - The builder that defines the item

Returns:

The added item

addActionItem

public final IActionItemModel addActionItem()

Description copied from interface: IMenuModel

Creates and adds a action item

Specified by:

addActionItem in interface IMenuModel

Returns:

The created action item

addActionItem

public final IActionItemModel addActionItem(java.lang.String text)

Description copied from interface: IMenuModel

Creates and adds a action item

Specified by:

addActionItem in interface IMenuModel

Parameters:

text - The label text of the action item

Returns:

The created action item

addActionItem

public final IActionItemModel addActionItem(java.lang.String text,
                             java.lang.String toolTipText)

Description copied from interface: IMenuModel

Creates and adds a action item

Specified by:

addActionItem in interface IMenuModel

Parameters:

text - The label text of the action item

toolTipText - The tooltip text of the action item

Returns:

The created action item

addActionItem

public final IActionItemModel addActionItem(java.lang.String text,
                             IImageConstant icon)

Description copied from interface: IMenuModel

Creates and adds a action item

Specified by:

addActionItem in interface IMenuModel

Parameters:

text - The label text of the action item

icon - The icon of the action item

Returns:

The created action item

addActionItem

public final IActionItemModel addActionItem(java.lang.String text,
                             java.lang.String toolTipText,
                             IImageConstant icon)

Description copied from interface: IMenuModel

Creates and adds a action item

Specified by:

addActionItem in interface IMenuModel

Parameters:

text - The label text of the action item

toolTipText - The tooltip text of the action item

icon - The icon of the action item

Returns:

The created action item

addCheckedItem

public final ICheckedItemModel addCheckedItem()

Description copied from interface: IMenuModel

Creates and adds a checked item

Specified by:

addCheckedItem in interface IMenuModel

Returns:

The created item

addCheckedItem

public final ICheckedItemModel addCheckedItem(java.lang.String text)

Description copied from interface: IMenuModel

Creates and adds a checked item

Specified by:

addCheckedItem in interface IMenuModel

Parameters:

text - The label text of the item

Returns:

The created item

addCheckedItem

public final ICheckedItemModel addCheckedItem(java.lang.String text,
                               java.lang.String toolTipText)

Description copied from interface: IMenuModel

Creates and adds a checked item

Specified by:

addCheckedItem in interface IMenuModel

Parameters:

text - The label text of the item

toolTipText - The tooltip text of the item

Returns:

The created item

addCheckedItem

public final ICheckedItemModel addCheckedItem(java.lang.String text,
                               IImageConstant icon)

Description copied from interface: IMenuModel

Creates and adds a checked item

Specified by:

addCheckedItem in interface IMenuModel

Parameters:

text - The label text of the item

icon - The icon of the item

Returns:

The created item

addCheckedItem

public final ICheckedItemModel addCheckedItem(java.lang.String text,
                               java.lang.String toolTipText,
                               IImageConstant icon)

Description copied from interface: IMenuModel

Creates and adds a checked item

Specified by:

addCheckedItem in interface IMenuModel

Parameters:

text - The label text of the item

toolTipText - The tooltip text of the item

icon - The icon of the item

Returns:

The created item

addRadioItem

public final IRadioItemModel addRadioItem()

Description copied from interface: IMenuModel

Creates and adds a radio item

Specified by:

addRadioItem in interface IMenuModel

Returns:

The created item

addRadioItem

public final IRadioItemModel addRadioItem(java.lang.String text)

Description copied from interface: IMenuModel

Creates and adds a radio item

Specified by:

addRadioItem in interface IMenuModel

Parameters:

text - The label text of the item

Returns:

The created item

addRadioItem

public final IRadioItemModel addRadioItem(java.lang.String text,
                           java.lang.String toolTipText)

Description copied from interface: IMenuModel

Creates and adds a radio item

Specified by:

addRadioItem in interface IMenuModel

Parameters:

text - The label text of the item

toolTipText - The tooltip text of the item

Returns:

The created item

addRadioItem

public final IRadioItemModel addRadioItem(java.lang.String text,
                           IImageConstant icon)

Description copied from interface: IMenuModel

Creates and adds a radio item

Specified by:

addRadioItem in interface IMenuModel

Parameters:

text - The label text of the item

icon - The icon of the item

Returns:

The created item

addRadioItem

public final IRadioItemModel addRadioItem(java.lang.String text,
                           java.lang.String toolTipText,
                           IImageConstant icon)

Description copied from interface: IMenuModel

Creates and adds a radio item

Specified by:

addRadioItem in interface IMenuModel

Parameters:

text - The label text of the item

toolTipText - The tooltip text of the item

icon - The icon of the item

Returns:

The created item

addSeparator

public final ISeparatorItemModel addSeparator(java.lang.String id)

Description copied from interface: IMenuModel

Creates and adds a separator

Specified by:

addSeparator in interface IMenuModel

Parameters:

id - The id of the separator

Returns:

The created item

addMenu

public final IMenuModel addMenu(java.lang.String text)

Description copied from interface: IMenuModel

Creates and add a submenu

Specified by:

addMenu in interface IMenuModel

Parameters:

text - The label text of the sub menu

Returns:

The created submenu

addMenu

public final IMenuModel addMenu(java.lang.String text,
                 java.lang.String toolTipText)

Description copied from interface: IMenuModel

Creates and add a submenu

Specified by:

addMenu in interface IMenuModel

Parameters:

text - The label text of the sub menu

toolTipText - The tooltip text of the submenu

Returns:

The created submenu

addMenu

public final IMenuModel addMenu(java.lang.String text,
                 IImageConstant icon)

Description copied from interface: IMenuModel

Creates and add a submenu

Specified by:

addMenu in interface IMenuModel

Parameters:

text - The label text of the sub menu

icon - The icon of the submenu

Returns:

The created submenu

addMenu

public final IMenuModel addMenu(java.lang.String text,
                 java.lang.String toolTipText,
                 IImageConstant icon)

Description copied from interface: IMenuModel

Creates and add a submenu

Specified by:

addMenu in interface IMenuModel

Parameters:

text - The label text of the sub menu

toolTipText - The tooltip text of the submenu

icon - The icon of the submenu

Returns:

The created submenu

addItemsOfModel

public final void addItemsOfModel(IMenuModel menuModel)

Description copied from interface: IMenuModel

Adds all items of a given model to this model

Specified by:

addItemsOfModel in interface IMenuModel

Parameters:

menuModel - The model which items should be added

bind

public final void bind(IMenuModel model)

Description copied from interface: IMenuModel

Binds the given model to this model with the following manner: 1. All items of the given model will be removed. 2. All items of this model will be added to the given model. 3. All changes on this model will be done on the given model.

Specified by:

bind in interface IMenuModel

Parameters:

model - The model to bind this model to

unbind

public final void unbind(IMenuModel model)

Description copied from interface: IMenuModel

Unbind the given model. Changes on this model will no longer be propagated to the given model.

Specified by:

unbind in interface IMenuModel

Parameters:

model - the model to unbind, may be not bound already but must not be null

addDecorator

public void addDecorator(IDecorator<IAction> decorator)

Description copied from interface: IMenuModel

Adds an action decorator for all actions contained in this menu an all sub menus. Remark: The decorator decorates the contained action and the actions that will be added in the future

Specified by:

addDecorator in interface IMenuModel

Parameters:

decorator - The decorator to add, must not be null

removeDecorator

public void removeDecorator(IDecorator<IAction> decorator)

Description copied from interface: IMenuModel

Removes a decorator for all actions contained in this menu an all sub menus. Remark: The decorator will only be removed for items that are still descendant of this menu. In other words: When removing an item before removing the decorator, the remove decorator invocation on the ancestor has no effect for the removed items.

Specified by:

removeDecorator in interface IMenuModel

Parameters:

decorator - The decorator to remove, must not be null

removeItem

public final void removeItem(IMenuItemModel item)

Description copied from interface: IMenuModel

Removes an item from this menu

Specified by:

removeItem in interface IMenuModel

Parameters:

item - The item to remove, must not be null

removeItem

public final void removeItem(int index)

Description copied from interface: IMenuModel

Removes an item at a given index

Specified by:

removeItem in interface IMenuModel

Parameters:

index - The index where to remove the item

removeAllItems

public final void removeAllItems()

Description copied from interface: IMenuModel

Removes all items from the menu

Specified by:

removeAllItems in interface IMenuModel

addListModelListener

public final void addListModelListener(IListModelListener listener)

Description copied from interface: IListModelObservable

Adds a list model listener

Specified by:

addListModelListener in interface IListModelObservable

Parameters:

listener - The listener to add

removeListModelListener

public final void removeListModelListener(IListModelListener listener)

Description copied from interface: IListModelObservable

removes a list model listener

Specified by:

removeListModelListener in interface IListModelObservable

Parameters:

listener - The listener to remove

createCopy

public IMenuModel createCopy()

Description copied from interface: IItemModel

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.

Specified by:

createCopy in interface IItemModel

Specified by:

createCopy in interface IMenuItemModel

Specified by:

createCopy in interface IMenuModel

Returns:

A new instance that is a clone of this instance

create

public static IMenuModel create()

Creates a new menu model instance

Returns:

The new menu model

builder

public static IMenuModelBuilder builder()

Creates a new menu model builder

Returns:

A new menu model builder

builder

public static IMenuModelBuilder builder(java.lang.String text)

Creates a new menu model builder and set defaults

Parameters:

text - The label text to set on the builder

Returns:

A new menu model builder

builder

public static IMenuModelBuilder builder(java.lang.String text,
                        java.lang.String toolTipText)

Creates a new menu model builder and set defaults

Parameters:

text - The label text to set on the builder

toolTipText - The tooltip text to set on the builder

Returns:

A new menu model builder

builder

public static IMenuModelBuilder builder(java.lang.String text,
                        IImageConstant icon)

Creates a new menu model builder and set defaults

Parameters:

text - The label text to set on the builder

icon - The icon to set on the builder

Returns:

A new menu model builder

builder

public static IMenuModelBuilder builder(java.lang.String text,
                        java.lang.String toolTipText,
                        IImageConstant icon)

Creates a new menu model builder and set defaults

Parameters:

text - The label text to set on the builder

toolTipText - The tooltip text to set on the builder

icon - The icon to set on the builder

Returns:

A new menu model builder

builder

public static IMenuModelBuilder builder(java.lang.String id,
                        java.lang.String text,
                        java.lang.String toolTipText,
                        IImageConstant icon)

Creates a new menu model builder and set defaults

Parameters:

id - The id to set on the builder

text - The label text to set on the builder

toolTipText - The tooltip text to set on the builder

icon - The icon to set on the builder

Returns:

A new menu model builder

getId

public final java.lang.String getId()

Description copied from interface: IItemModel

Gets the id of the item

Specified by:

getId in interface IItemModel

Returns:

The id of the item, never null

getText

public final java.lang.String getText()

Description copied from interface: IItemModel

Gets the items label text

Specified by:

getText in interface IItemModel

Returns:

The label text of the item, may be null

getToolTipText

public final java.lang.String getToolTipText()

Description copied from interface: IItemModel

Gets the tooltip text of the item

Specified by:

getToolTipText in interface IItemModel

Returns:

The tooltip text, may be null

getIcon

public final IImageConstant getIcon()

Description copied from interface: IItemModel

Gets the items icon

Specified by:

getIcon in interface IItemModel

Returns:

The icon, may be null

getAccelerator

public final Accelerator getAccelerator()

Description copied from interface: IItemModel

Gets the key accelerator that should be used for the item

Specified by:

getAccelerator in interface IItemModel

Returns:

The key accelerator, may be null

getMnemonic

public final java.lang.Character getMnemonic()

Description copied from interface: IItemModel

Gets the mnemonic character

Specified by:

getMnemonic in interface IItemModel

Returns:

The mnemonic character, may be null

isEnabled

public final boolean isEnabled()

Description copied from interface: IItemModel

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

Specified by:

isEnabled in interface IItemModel

Returns:

true if enabled, false otherwise

setText

public final void setText(java.lang.String text)

Description copied from interface: IItemModel

Sets the items label text

Specified by:

setText in interface IItemModel

Parameters:

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

setToolTipText

public final void setToolTipText(java.lang.String toolTipText)

Description copied from interface: IItemModel

Sets the tooltip text for the item

Specified by:

setToolTipText in interface IItemModel

Parameters:

toolTipText - The tooltip text to set, may be null

setIcon

public final void setIcon(IImageConstant icon)

Description copied from interface: IItemModel

Sets the items icon

Specified by:

setIcon in interface IItemModel

Parameters:

icon - The icon to set, may be null

setAccelerator

public final void setAccelerator(Accelerator accelerator)

Description copied from interface: IItemModel

Sets the key accelerator that should be used for the item

Specified by:

setAccelerator in interface IItemModel

Parameters:

accelerator - The accelerator to set, may be null

setAccelerator

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

Description copied from interface: IItemModel

Sets the key accelerator that should be used for the item

Specified by:

setAccelerator in interface IItemModel

Parameters:

key - The character to use

modifier - The modifier to use

setMnemonic

public final void setMnemonic(java.lang.Character mnemonic)

Description copied from interface: IItemModel

Sets the mnemonic character

Specified by:

setMnemonic in interface IItemModel

Parameters:

mnemonic - The mnemonic character to set, may be null

setMnemonic

public final void setMnemonic(char mnemonic)

Description copied from interface: IItemModel

Sets the mnemonic character

Specified by:

setMnemonic in interface IItemModel

Parameters:

mnemonic - The mnemonic character to set

setEnabled

public final void setEnabled(boolean enabled)

Description copied from interface: IItemModel

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

Specified by:

setEnabled in interface IItemModel

Parameters:

enabled - The enabled state to set

setVisible

public void setVisible(boolean visible)

Description copied from interface: IItemModel

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

Specified by:

setVisible in interface IItemModel

Parameters:

visible - The visible state to set

isVisible

public boolean isVisible()

Description copied from interface: IItemModel

Gets the visible state of the item

Specified by:

isVisible in interface IItemModel

Returns:

True if visible, false otherwise

addItemModelListener

public final void addItemModelListener(IItemModelListener listener)

Description copied from interface: IItemModelObservable

Adds a item model listener

Specified by:

addItemModelListener in interface IItemModelObservable

Parameters:

listener - The listener to add

removeItemModelListener

public final void removeItemModelListener(IItemModelListener listener)

Description copied from interface: IItemModelObservable

removes a item model listener

Specified by:

removeItemModelListener in interface IItemModelObservable

Parameters:

listener - The listener to remove

unwrap

public IItemModel unwrap()

Specified by:

unwrap in interface IWrapper<IItemModel>

Returns:

The unwrapped (original) instance

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object