org.jowidgets.api.model.item

Interface IItemModelBuilder<INSTANCE_TYPE,ITEM_TYPE>

All Known Subinterfaces:

IActionItemModelBuilder, ICheckedItemModelBuilder, IContainerItemModelBuilder, IMenuModelBuilder, IPopupActionItemModelBuilder, IRadioItemModelBuilder, ISelectableItemModelBuilder<INSTANCE_TYPE,ITEM_TYPE>, ISeparatorItemModelBuilder

public interface IItemModelBuilder<INSTANCE_TYPE,ITEM_TYPE>

Method Summary

Methods

Modifier and Type	Method and Description
ITEM_TYPE	build() Creates a new model based on the given setup
INSTANCE_TYPE	setAccelerator(Accelerator accelerator) Sets the key accelerator
INSTANCE_TYPE	setAccelerator(char key, Modifier... modifier) Sets the key accelerator
INSTANCE_TYPE	setAccelerator(VirtualKey key, Modifier... modifier) Sets the key accelerator
INSTANCE_TYPE	setEnabled(boolean enabled) Sets the initial enabled state The default value is true
INSTANCE_TYPE	setIcon(IImageConstant icon) Sets the icon
INSTANCE_TYPE	setId(java.lang.String id) The the id if the item.
INSTANCE_TYPE	setMnemonic(char mnemonic) Sets the mnemonic
INSTANCE_TYPE	setMnemonic(java.lang.Character mnemonic) Sets the mnemonic
INSTANCE_TYPE	setText(java.lang.String text) Sets the label text
INSTANCE_TYPE	setToolTipText(java.lang.String toolTipText) Sets the tooltip text

Method Detail

setId

INSTANCE_TYPE setId(java.lang.String id)

The the id if the item. If no id will be set or null will set, a UUID will be used

Parameters:

id - The id to set

Returns:

This builder

setText

INSTANCE_TYPE setText(java.lang.String text)

Sets the label text

Parameters:

text - The label text to set

Returns:

This builder

setToolTipText

INSTANCE_TYPE setToolTipText(java.lang.String toolTipText)

Sets the tooltip text

Parameters:

toolTipText - The tooltip text to set

Returns:

This builder

setIcon

INSTANCE_TYPE setIcon(IImageConstant icon)

Sets the icon

Parameters:

icon - The icon to set

Returns:

This builder

setAccelerator

INSTANCE_TYPE setAccelerator(Accelerator accelerator)

Sets the key accelerator

Parameters:

accelerator - The accelerator to set

Returns:

This builder

setAccelerator

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

Sets the key accelerator

Parameters:

key - The virtual key of the accelerator

modifier - The modifier of the accelerator

Returns:

This builder

setAccelerator

INSTANCE_TYPE setAccelerator(char key,
                           Modifier... modifier)

Sets the key accelerator

Parameters:

key - The key character of the accelerator

modifier - The modifier of the accelerator

Returns:

This builder

setMnemonic

INSTANCE_TYPE setMnemonic(java.lang.Character mnemonic)

Sets the mnemonic

Parameters:

mnemonic - The mnemonic to set

Returns:

This builder

setMnemonic

INSTANCE_TYPE setMnemonic(char mnemonic)

Sets the mnemonic

Parameters:

mnemonic - The mnemonic to set

Returns:

This builder

setEnabled

INSTANCE_TYPE setEnabled(boolean enabled)

Sets the initial enabled state The default value is true

Parameters:

enabled - The enabled state to set

Returns:

This builder

build

ITEM_TYPE build()

Creates a new model based on the given setup

Returns:

A new model