org.jowidgets.tools.powo

Class JoSubMenu

java.lang.Object

org.jowidgets.tools.powo.JoSubMenu

All Implemented Interfaces:

IDisposeObservable, IItem, IMenu, IMenuItem, ISubMenu, IWidget, IMenuObservable, IItemCommon, IMenuCommon, IMenuItemCommon, ISubMenuCommon, IWidgetCommon, IJoMenu

Deprecated.

The idea of POWO's (Plain Old Widget Object's) has not been established. For that, POWO's will no longer be supported and may removed completely in middle term. Feel free to move them to your own open source project.

@Deprecated
public class JoSubMenu
extends java.lang.Object
implements ISubMenu

Constructor Summary

Constructors

Constructor and Description
JoSubMenu(ISubMenuDescriptor descriptor) Deprecated.
JoSubMenu(java.lang.String text) Deprecated.
JoSubMenu(java.lang.String text, IImageConstant icon) Deprecated.
JoSubMenu(java.lang.String text, java.lang.String tooltipText) Deprecated.

Method Summary

Methods

Modifier and Type	Method and Description
IActionMenuItem	addAction(IAction action) Deprecated. Adds an action item to the menu that will be bound to the given action
IActionMenuItem	addAction(int index, IAction action) Deprecated. Adds an action item to the menu at a specific that will be bound to the given action
void	addDisposeListener(IDisposeListener listener) Deprecated. Adds a dispose listener
<RESULT_WIDGET_TYPE extends IMenuItem> RESULT_WIDGET_TYPE	addItem(int index, IWidgetDescriptor<? extends RESULT_WIDGET_TYPE> descriptor) Deprecated. Adds a menu item to the menu at a specific index
void	addItem(int index, org.jowidgets.tools.powo.MenuItem<? extends IMenuItem,?> item) Deprecated.
void	addItem(int index, org.jowidgets.tools.powo.SubMenu<? extends ISubMenu,?> item) Deprecated.
<RESULT_WIDGET_TYPE extends IMenuItem> RESULT_WIDGET_TYPE	addItem(IWidgetDescriptor<? extends RESULT_WIDGET_TYPE> descriptor) Deprecated. Adds a menu item to the menu
void	addItem(org.jowidgets.tools.powo.MenuItem<? extends IMenuItem,?> item) Deprecated.
void	addItem(org.jowidgets.tools.powo.SubMenu<? extends ISubMenu,?> item) Deprecated.
void	addMenuListener(IMenuListener listener) Deprecated. Adds a menu listener
IMenuItem	addSeparator() Deprecated. Adds a separator item to the menu
IMenuItem	addSeparator(int index) Deprecated. Adds a separator item to the menu at a specific index
static ISubMenuBluePrint	bluePrint() Deprecated.
static ISubMenuBluePrint	bluePrint(java.lang.String text) Deprecated.
static ISubMenuBluePrint	bluePrint(java.lang.String text, IImageConstant icon) Deprecated.
static ISubMenuBluePrint	bluePrint(java.lang.String text, java.lang.String tooltipText) Deprecated.
void	dispose() Deprecated. Disposes the widgets.
java.util.List<IMenuItem>	getChildren() Deprecated. Gets the menu items of the menu as a unmodifieable copy
IImageConstant	getIcon() Deprecated. Gets the icon of the item
IMenuModel	getModel() Deprecated. Gets the model of the menu
IMenu	getParent() Deprecated. Gets the parent of the widget
IWidget	getRoot() Deprecated. Gets the root widget of the widget If the widget is a composed widget, the root widget of the composed widget will be returned.
java.lang.String	getText() Deprecated. Gets the text of the item
java.lang.String	getToolTipText() Deprecated. Gets the tooltip text of the item
java.lang.Object	getUiReference() Deprecated. Gets the reference to the ui implementation of this widget.
boolean	isDisposed() Deprecated. Checks if a widget is disposed
boolean	isEnabled() Deprecated. Gets the enabled state
boolean	isInitialized() Deprecated.
boolean	remove(IMenuItem item) Deprecated. Removes a menu item form the menu
void	removeAll() Deprecated. Removes all items from the menu
void	removeDisposeListener(IDisposeListener listener) Deprecated. Removes a dispose listener
void	removeMenuListener(IMenuListener listener) Deprecated. Removes a menu listener
void	setEnabled(boolean enabled) Deprecated. Sets the widget enabled
void	setIcon(IImageConstant icon) Deprecated. Sets a icon for the item
void	setMnemonic(char mnemonic) Deprecated. Sets the keyboard mnemonic The mnemonic is the key that will activate the item when combined with (usually) ALT key.
void	setModel(IMenuItemModel model) Deprecated. Sets the model of the menu
void	setModel(IMenuModel model) Deprecated. Sets the model of the menu
void	setText(java.lang.String text) Deprecated. Sets the items text
void	setToolTipText(java.lang.String text) Deprecated. Sets the items tooltip text

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jowidgets.api.widgets.IMenu

addAction, addAction, addItem, addItem, addSeparator, addSeparator, getChildren, getModel, remove, removeAll, setModel

Methods inherited from interface org.jowidgets.api.widgets.IMenuItem

getModel, getParent, setModel

Methods inherited from interface org.jowidgets.api.widgets.IItem

getIcon, getText, getToolTipText

Methods inherited from interface org.jowidgets.api.widgets.IWidget

dispose, getRoot, isDisposed

Methods inherited from interface org.jowidgets.api.controller.IDisposeObservable

addDisposeListener, removeDisposeListener

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

addMenuListener, removeMenuListener

Methods inherited from interface org.jowidgets.common.widgets.IMenuItemCommon

setMnemonic

Methods inherited from interface org.jowidgets.common.widgets.IItemCommon

setIcon, setText, setToolTipText

Constructor Detail

JoSubMenu

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

Deprecated.

JoSubMenu

public JoSubMenu(java.lang.String text)

Deprecated.

JoSubMenu

public JoSubMenu(java.lang.String text,
         java.lang.String tooltipText)

Deprecated.

JoSubMenu

public JoSubMenu(ISubMenuDescriptor descriptor)

Deprecated.

Method Detail

bluePrint

public static ISubMenuBluePrint bluePrint()

Deprecated.

bluePrint

public static ISubMenuBluePrint bluePrint(java.lang.String text)

Deprecated.

bluePrint

public static ISubMenuBluePrint bluePrint(java.lang.String text,
                          java.lang.String tooltipText)

Deprecated.

bluePrint

public static ISubMenuBluePrint bluePrint(java.lang.String text,
                          IImageConstant icon)

Deprecated.

setText

public void setText(java.lang.String text)

Deprecated.

Description copied from interface: IItemCommon

Sets the items text

Specified by:

setText in interface IItemCommon

Parameters:

text - The text to set, may be null

setToolTipText

public void setToolTipText(java.lang.String text)

Deprecated.

Description copied from interface: IItemCommon

Sets the items tooltip text

Specified by:

setToolTipText in interface IItemCommon

Parameters:

text - The text to set

setIcon

public void setIcon(IImageConstant icon)

Deprecated.

Description copied from interface: IItemCommon

Sets a icon for the item

Specified by:

setIcon in interface IItemCommon

Parameters:

icon - The icon to set

setMnemonic

public void setMnemonic(char mnemonic)

Deprecated.

Description copied from interface: IMenuItemCommon

Sets the keyboard mnemonic The mnemonic is the key that will activate the item when combined with (usually) ALT key. A mnemonic must correspond to a single key and is case-insensitive. The first occurrence of the mnemonic key will be underlined in the menu label to indicate the mnemonic to the user

Specified by:

setMnemonic in interface IMenuItemCommon

Parameters:

mnemonic - The mnemonic to set

getParent

public IMenu getParent()

Deprecated.

Description copied from interface: IWidget

Gets the parent of the widget

Specified by:

getParent in interface IMenuItem

Specified by:

getParent in interface IWidget

Returns:

The widgets parent or null, if the widget has no parent

getText

public java.lang.String getText()

Deprecated.

Description copied from interface: IItem

Gets the text of the item

Specified by:

getText in interface IItem

Returns:

The items text or null if no text is defined

getToolTipText

public java.lang.String getToolTipText()

Deprecated.

Description copied from interface: IItem

Gets the tooltip text of the item

Specified by:

getToolTipText in interface IItem

Returns:

The items tooltip text or null if no tooltip is defined

getIcon

public IImageConstant getIcon()

Deprecated.

Description copied from interface: IItem

Gets the icon of the item

Specified by:

getIcon in interface IItem

Returns:

The items icon or null if no icon is defined

setModel

public void setModel(IMenuItemModel model)

Deprecated.

Description copied from interface: IMenuItem

Sets the model of the menu

Specified by:

setModel in interface IMenuItem

Parameters:

model - The model to set, must not be null

addItem

public void addItem(org.jowidgets.tools.powo.MenuItem<? extends IMenuItem,?> item)

Deprecated.

Specified by:

addItem in interface IJoMenu

addItem

public void addItem(int index,
           org.jowidgets.tools.powo.MenuItem<? extends IMenuItem,?> item)

Deprecated.

Specified by:

addItem in interface IJoMenu

addItem

public void addItem(org.jowidgets.tools.powo.SubMenu<? extends ISubMenu,?> item)

Deprecated.

Specified by:

addItem in interface IJoMenu

addItem

public void addItem(int index,
           org.jowidgets.tools.powo.SubMenu<? extends ISubMenu,?> item)

Deprecated.

Specified by:

addItem in interface IJoMenu

addMenuListener

public void addMenuListener(IMenuListener listener)

Deprecated.

Description copied from interface: IMenuObservable

Adds a menu listener

Specified by:

addMenuListener in interface IMenuObservable

Parameters:

listener - The listener to add

removeMenuListener

public void removeMenuListener(IMenuListener listener)

Deprecated.

Description copied from interface: IMenuObservable

Removes a menu listener

Specified by:

removeMenuListener in interface IMenuObservable

Parameters:

listener - The listener to remove

getChildren

public java.util.List<IMenuItem> getChildren()

Deprecated.

Description copied from interface: IMenu

Gets the menu items of the menu as a unmodifieable copy

Specified by:

getChildren in interface IMenu

Returns:

The menu items of the menu, never null but may be empty

remove

public boolean remove(IMenuItem item)

Deprecated.

Description copied from interface: IMenu

Removes a menu item form the menu

Specified by:

remove in interface IMenu

Parameters:

item - The item to remove

Returns:

True if the item was removed, false of the item is no child of the menu

removeAll

public void removeAll()

Deprecated.

Description copied from interface: IMenu

Removes all items from the menu

Specified by:

removeAll in interface IMenu

addItem

public <RESULT_WIDGET_TYPE extends IMenuItem> RESULT_WIDGET_TYPE addItem(IWidgetDescriptor<? extends RESULT_WIDGET_TYPE> descriptor)

Deprecated.

Description copied from interface: IMenu

Adds a menu item to the menu

Specified by:

addItem in interface IMenu

Parameters:

descriptor - The descriptor for the item to add, must not be null

Returns:

The created menu item

addItem

public <RESULT_WIDGET_TYPE extends IMenuItem> RESULT_WIDGET_TYPE addItem(int index,
                                                                IWidgetDescriptor<? extends RESULT_WIDGET_TYPE> descriptor)

Deprecated.

Description copied from interface: IMenu

Adds a menu item to the menu at a specific index

Specified by:

addItem in interface IMenu

Parameters:

index - The index where to add the item

descriptor - The descriptor for the item to add, must not be null

Returns:

The created menu item

addSeparator

public IMenuItem addSeparator()

Deprecated.

Description copied from interface: IMenu

Adds a separator item to the menu

Specified by:

addSeparator in interface IMenu

Returns:

The separator item that was added

addSeparator

public IMenuItem addSeparator(int index)

Deprecated.

Description copied from interface: IMenu

Adds a separator item to the menu at a specific index

Specified by:

addSeparator in interface IMenu

Parameters:

index - The index where to add the separarot item

Returns:

The separator item that was added

addAction

public IActionMenuItem addAction(IAction action)

Deprecated.

Description copied from interface: IMenu

Adds an action item to the menu that will be bound to the given action

Specified by:

addAction in interface IMenu

Parameters:

action - The action to add, must not be null

Returns:

The action item that was created

addAction

public IActionMenuItem addAction(int index,
                        IAction action)

Deprecated.

Description copied from interface: IMenu

Adds an action item to the menu at a specific that will be bound to the given action

Specified by:

addAction in interface IMenu

Parameters:

index - The index where to add the item

action - The action to add, must not be null

Returns:

The action item that was created

getModel

public IMenuModel getModel()

Deprecated.

Description copied from interface: IMenu

Gets the model of the menu

Specified by:

getModel in interface IMenu

Returns:

The model, never null

setModel

public void setModel(IMenuModel model)

Deprecated.

Description copied from interface: IMenu

Sets the model of the menu

Specified by:

setModel in interface IMenu

Parameters:

model - The model to set, must not be null

isInitialized

public final boolean isInitialized()

Deprecated.

getRoot

public IWidget getRoot()

Deprecated.

Description copied from interface: IWidget

Gets the root widget of the widget If the widget is a composed widget, the root widget of the composed widget will be returned. If the widget is not composed, 'this' widget will be returned.

Specified by:

getRoot in interface IWidget

Returns:

the root widget, never null

addDisposeListener

public void addDisposeListener(IDisposeListener listener)

Deprecated.

Description copied from interface: IDisposeObservable

Adds a dispose listener

Specified by:

addDisposeListener in interface IDisposeObservable

Parameters:

listener - The listener to add

removeDisposeListener

public void removeDisposeListener(IDisposeListener listener)

Deprecated.

Description copied from interface: IDisposeObservable

Removes a dispose listener

Specified by:

removeDisposeListener in interface IDisposeObservable

Parameters:

listener - The listener to remove

dispose

public void dispose()

Deprecated.

Description copied from interface: IWidget

Disposes the widgets. After a widget was disposed, it can longer be used.

Specified by:

dispose in interface IWidget

isDisposed

public boolean isDisposed()

Deprecated.

Description copied from interface: IWidget

Checks if a widget is disposed

Specified by:

isDisposed in interface IWidget

Returns:

True if the widget is disposed, false otherwise

setEnabled

public void setEnabled(boolean enabled)

Deprecated.

Description copied from interface: IWidgetCommon

Sets the widget enabled

Specified by:

setEnabled in interface IWidgetCommon

Parameters:

enabled - The enabled state to set

isEnabled

public boolean isEnabled()

Deprecated.

Description copied from interface: IWidgetCommon

Gets the enabled state

Specified by:

isEnabled in interface IWidgetCommon

Returns:

The enabled state

getUiReference

public final java.lang.Object getUiReference()

Deprecated.

Description copied from interface: IWidgetCommon

Gets the reference to the ui implementation of this widget. The type depends on the SPI Implementation used. With the Swing SPI implementation e.g a IComposite will return a javax.swing.JPanel or a IButton will return a javax.swing.JButton With the SWT SPI implementation e.g a IComposite will return a org.eclipse.swt.widgets.Composite or a IButton will return a org.eclipse.swt.widgets.Button

Specified by:

getUiReference in interface IWidgetCommon

Returns:

the ui reference, never null