org.jowidgets.tools.model.item

Class RadioItemModel

java.lang.Object

org.jowidgets.tools.model.item.RadioItemModel

All Implemented Interfaces:

IItemModel, IItemModelObservable, IMenuItemModel, IRadioItemModel, ISelectableItemModel, ISelectableMenuItemModel, IItemStateObservable, IWrapper<IItemModel>

public class RadioItemModel
extends java.lang.Object
implements IRadioItemModel

Constructor Summary

Constructors

Constructor and Description
RadioItemModel() Creates a new checked item model
RadioItemModel(IRadioItemModelBuilder builder) Creates a checked item model defined by a builder
RadioItemModel(java.lang.String text) Creates a new checked item model
RadioItemModel(java.lang.String text, IImageConstant icon) Creates a new checked item model
RadioItemModel(java.lang.String text, java.lang.String toolTipText) Creates a new checked item model
RadioItemModel(java.lang.String text, java.lang.String toolTipText, IImageConstant icon) Creates a new checked item model
RadioItemModel(java.lang.String id, java.lang.String text, java.lang.String toolTipText, IImageConstant icon) Creates a new checked item model

Method Summary

Methods

Modifier and Type	Method and Description
void	addItemListener(IItemStateListener listener) Adds an item state listener
void	addItemModelListener(IItemModelListener listener) Adds a item model listener
static IRadioItemModelBuilder	builder() Creates a new checked item model builder
static IRadioItemModelBuilder	builder(java.lang.String text) Creates a new checked item model builder
static IRadioItemModelBuilder	builder(java.lang.String text, IImageConstant icon) Creates a new checked item model builder
static IRadioItemModelBuilder	builder(java.lang.String text, java.lang.String toolTipText) Creates a new checked item model builder
static IRadioItemModelBuilder	builder(java.lang.String text, java.lang.String toolTipText, IImageConstant icon) Creates a new checked item model builder
static IRadioItemModelBuilder	builder(java.lang.String id, java.lang.String text, java.lang.String toolTipText, IImageConstant icon) Creates a new checked item model builder
static IRadioItemModel	create() Creates a new checked item model
IRadioItemModel	createCopy() Creates a deep copy of the item and its children.
boolean	equals(java.lang.Object obj)
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
protected IRadioItemModel	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	isSelected() Gets the selected state
boolean	isVisible() Gets the visible state of the item
void	removeItemListener(IItemStateListener listener) Removes an item state 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	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	setSelected(boolean selected) Sets the selected state
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
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.ISelectableItemModel

isSelected, setSelected

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

Methods inherited from interface org.jowidgets.common.widgets.controller.IItemStateObservable

addItemListener, removeItemListener

Constructor Detail

RadioItemModel

public RadioItemModel()

Creates a new checked item model

RadioItemModel

public RadioItemModel(java.lang.String text)

Creates a new checked item model

Parameters:

text - The label text to use

RadioItemModel

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

Creates a new checked item model

Parameters:

text - The label text to use

icon - The icon to use

RadioItemModel

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

Creates a new checked item model

Parameters:

text - The label text to use

toolTipText - The tooltip text to use

RadioItemModel

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

Creates a new checked item model

Parameters:

text - The label text to use

toolTipText - The tooltip text to use

icon - The icon to use

RadioItemModel

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

Creates a new checked item model

Parameters:

id - The id to use

text - The label text to use

toolTipText - The tooltip text to use

icon - The icon to use

RadioItemModel

public RadioItemModel(IRadioItemModelBuilder builder)

Creates a checked item model defined by a builder

Parameters:

builder - The builder that defines the model

Method Detail

getItemModel

protected IRadioItemModel getItemModel()

createCopy

public IRadioItemModel 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 IRadioItemModel

Returns:

A new instance that is a clone of this instance

create

public static IRadioItemModel create()

Creates a new checked item model

Returns:

A new checked item model

builder

public static IRadioItemModelBuilder builder()

Creates a new checked item model builder

Returns:

A new checked item model builder

builder

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

Creates a new checked item model builder

Parameters:

text - The label text to set on the builder

Returns:

A new checked item model builder

builder

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

Creates a new checked item model builder

Parameters:

text - The label text to set on the builder

toolTipText - The tooltip text to set on the builder

Returns:

A new checked item model builder

builder

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

Creates a new checked item model builder

Parameters:

text - The label text to set on the builder

icon - The icon to set on the builder

Returns:

A new checked item model builder

builder

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

Creates a new checked item model builder

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 checked item model builder

builder

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

Creates a new checked item model builder

Parameters:

id - The id to set on 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 checked item model builder

addItemListener

public final void addItemListener(IItemStateListener listener)

Description copied from interface: IItemStateObservable

Adds an item state listener

Specified by:

addItemListener in interface IItemStateObservable

Parameters:

listener - The listener to add

removeItemListener

public final void removeItemListener(IItemStateListener listener)

Description copied from interface: IItemStateObservable

Removes an item state listener

Specified by:

removeItemListener in interface IItemStateObservable

Parameters:

listener - The listener to remove

isSelected

public final boolean isSelected()

Description copied from interface: ISelectableItemModel

Gets the selected state

Specified by:

isSelected in interface ISelectableItemModel

Returns:

True if selected, false otherwise

setSelected

public final void setSelected(boolean selected)

Description copied from interface: ISelectableItemModel

Sets the selected state

Specified by:

setSelected in interface ISelectableItemModel

Parameters:

selected - The selected state to set

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