org.jowidgets.tools.model.item

Class PopupActionItemModel

java.lang.Object

org.jowidgets.tools.model.item.PopupActionItemModel

All Implemented Interfaces:

IItemModel, IItemModelObservable, IPopupActionItemModel, IToolBarItemModel, IActionObservable, IWrapper<IItemModel>

public class PopupActionItemModel
extends java.lang.Object
implements IPopupActionItemModel

Constructor Summary

Constructors

Constructor and Description
PopupActionItemModel()
PopupActionItemModel(IAction action)
PopupActionItemModel(IAction action, IMenuModel popupMenu)
PopupActionItemModel(IPopupActionItemModelBuilder builder)
PopupActionItemModel(java.lang.String text)
PopupActionItemModel(java.lang.String text, IImageConstant icon)
PopupActionItemModel(java.lang.String text, java.lang.String toolTipText)
PopupActionItemModel(java.lang.String text, java.lang.String toolTipText, IImageConstant icon)
PopupActionItemModel(java.lang.String id, java.lang.String text, java.lang.String toolTipText, IImageConstant icon)

Method Summary

Methods

Modifier and Type	Method and Description
void	actionPerformed()
void	addActionListener(IActionListener actionListener) Adds an action listener
void	addItemModelListener(IItemModelListener listener) Adds a item model listener
static IPopupActionItemModelBuilder	builder()
static IPopupActionItemModelBuilder	builder(IAction action)
static IPopupActionItemModelBuilder	builder(IAction action, IMenuModel popupMenu)
static IPopupActionItemModelBuilder	builder(java.lang.String text)
static IPopupActionItemModelBuilder	builder(java.lang.String text, IImageConstant icon)
static IPopupActionItemModelBuilder	builder(java.lang.String text, java.lang.String toolTipText)
static IPopupActionItemModelBuilder	builder(java.lang.String text, java.lang.String toolTipText, IImageConstant icon)
static IPopupActionItemModelBuilder	builder(java.lang.String id, java.lang.String text, java.lang.String toolTipText, IImageConstant icon)
IPopupActionItemModel	createCopy() Makes a deep copy of the item.
boolean	equals(java.lang.Object obj)
Accelerator	getAccelerator() Gets the key accelerator that should be used for the item
IAction	getAction()
IImageConstant	getIcon() Gets the items icon
java.lang.String	getId() Gets the id of the item
IPopupActionItemModel	getItemModel()
java.lang.Character	getMnemonic() Gets the mnemonic character
IMenuModel	getPopupMenu()
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	removeActionListener(IActionListener actionListener) Removes an action listener
void	removeItemModelListener(IItemModelListener listener) removes a item 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	setAction(IAction action)
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	setPopupMenu(IMenuModel popupMenu) Sets a popup menu for this tool bar popup button.
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
java.lang.String	toString()
IItemModel	unwrap()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, 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

PopupActionItemModel

public PopupActionItemModel()

PopupActionItemModel

public PopupActionItemModel(IAction action)

PopupActionItemModel

public PopupActionItemModel(IAction action,
                    IMenuModel popupMenu)

PopupActionItemModel

public PopupActionItemModel(java.lang.String text)

PopupActionItemModel

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

PopupActionItemModel

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

PopupActionItemModel

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

PopupActionItemModel

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

PopupActionItemModel

public PopupActionItemModel(IPopupActionItemModelBuilder builder)

Method Detail

getItemModel

public IPopupActionItemModel getItemModel()

addActionListener

public final void addActionListener(IActionListener actionListener)

Description copied from interface: IActionObservable

Adds an action listener

Specified by:

addActionListener in interface IActionObservable

Parameters:

actionListener - The listener to add

removeActionListener

public final void removeActionListener(IActionListener actionListener)

Description copied from interface: IActionObservable

Removes an action listener

Specified by:

removeActionListener in interface IActionObservable

Parameters:

actionListener - The listener to remove

getAction

public final IAction getAction()

Specified by:

getAction in interface IPopupActionItemModel

setAction

public final void setAction(IAction action)

Specified by:

setAction in interface IPopupActionItemModel

setPopupMenu

public final void setPopupMenu(IMenuModel popupMenu)

Description copied from interface: IPopupActionItemModel

Sets a popup menu for this tool bar popup button. The popup menu will be shown, when the popup button is pressed.

Specified by:

setPopupMenu in interface IPopupActionItemModel

getPopupMenu

public final IMenuModel getPopupMenu()

Specified by:

getPopupMenu in interface IPopupActionItemModel

actionPerformed

public final void actionPerformed()

Specified by:

actionPerformed in interface IPopupActionItemModel

createCopy

public IPopupActionItemModel createCopy()

Description copied from interface: IPopupActionItemModel

Makes a deep copy of the item. Registered listeners on items won't be copied. The Action won't be cloned.

Specified by:

createCopy in interface IItemModel

Specified by:

createCopy in interface IPopupActionItemModel

Returns:

A new instance that is a clone of this instance

builder

public static IPopupActionItemModelBuilder builder()

builder

public static IPopupActionItemModelBuilder builder(IAction action)

builder

public static IPopupActionItemModelBuilder builder(IAction action,
                                   IMenuModel popupMenu)

builder

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

builder

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

builder

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

builder

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

builder

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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

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