org.drombler.acp.core.action.spi

Class ToggleMenuEntryDescriptor<MenuItem,ToggleMenuItem extends MenuItem,F extends MenuItemSupplierFactory<MenuItem,F>>

java.lang.Object

org.drombler.acp.core.action.spi.AbstractMenuEntryDescriptor<MenuItem,F>

org.drombler.acp.core.action.spi.MenuEntryDescriptor<MenuItem,F>

org.drombler.acp.core.action.spi.ToggleMenuEntryDescriptor<MenuItem,ToggleMenuItem,F>

Type Parameters:

MenuItem - the GUI toolkit specific type for menu items

ToggleMenuItem - the GUI toolkit specific type for toggle menu items

F - the sorting strategy specific menu item supplier factory type

public class ToggleMenuEntryDescriptor<MenuItem,ToggleMenuItem extends MenuItem,F extends MenuItemSupplierFactory<MenuItem,F>>
extends MenuEntryDescriptor<MenuItem,F>

A toggle menu entry desciptor.

Author:

puce

Constructor Summary

Constructors

Constructor and Description
ToggleMenuEntryDescriptor(String actionId, String path, F menuItemSupplierFactory) Creates a new instance of this class.
ToggleMenuEntryDescriptor(String actionId, String toggleGroupId, String path, F menuItemSupplierFactory) Creates a new instance of this class.

Method Summary

Modifier and Type	Method and Description
static <MenuItem,ToggleMenuItem extends MenuItem> ToggleMenuEntryDescriptor<MenuItem,ToggleMenuItem,PositionableMenuItemAdapterFactory<MenuItem>>	createToggleMenuEntryDescriptor(ToggleMenuEntryType menuEntryType) Creates an instance of a ToggleMenuEntryDescriptor from a ToggleMenuEntryType unmarshalled from the application.xml.
String	getToggleGroupId() Gets the toggle group id or null if the toggle menu entry should not be part of a toggle group.

Methods inherited from class org.drombler.acp.core.action.spi.MenuEntryDescriptor

createMenuEntryDescriptor, getActionId, toString

Methods inherited from class org.drombler.acp.core.action.spi.AbstractMenuEntryDescriptor

getMenuItemSupplierFactory, getPath

Methods inherited from class java.lang.Object

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

Constructor Detail

ToggleMenuEntryDescriptor

public ToggleMenuEntryDescriptor(String actionId,
                                 String toggleGroupId,
                                 String path,
                                 F menuItemSupplierFactory)

Creates a new instance of this class.

Parameters:

actionId - the id of the toggle action for this toggle menu entry

toggleGroupId - the toggle group id or null if the toggle menu entry should not be part of a toggle group

path - the path

menuItemSupplierFactory - the menu item supplier factory

ToggleMenuEntryDescriptor

public ToggleMenuEntryDescriptor(String actionId,
                                 String path,
                                 F menuItemSupplierFactory)

Creates a new instance of this class. The toggle group id is set to null, so the toggle menu entry won't be part of a toggle group

Parameters:

actionId - he id of the toggle action for this toggle menu entry

path - the path

menuItemSupplierFactory - the menu item supplier factory

Method Detail

getToggleGroupId

public String getToggleGroupId()

Gets the toggle group id or null if the toggle menu entry should not be part of a toggle group.

Returns:

the toggle group id or null if the toggle menu entry should not be part of a toggle group

createToggleMenuEntryDescriptor

public static <MenuItem,ToggleMenuItem extends MenuItem> ToggleMenuEntryDescriptor<MenuItem,ToggleMenuItem,PositionableMenuItemAdapterFactory<MenuItem>> createToggleMenuEntryDescriptor(ToggleMenuEntryType menuEntryType)

Creates an instance of a ToggleMenuEntryDescriptor from a ToggleMenuEntryType unmarshalled from the application.xml.

Type Parameters:

MenuItem - the GUI toolkit specific type for menu items

ToggleMenuItem - the GUI toolkit specific type for toggle menu items

Parameters:

menuEntryType - the unmarshalled MenuEntryType

Returns:

a ToggleMenuEntryDescriptor