com.goldencode.p2j.ui

Class MenuDescription

java.lang.Object

com.goldencode.p2j.ui.MenuDescription

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable

public class MenuDescription
extends java.lang.Object
implements java.io.Externalizable

This is a container for the configuration of a given menu or family of menus which is efficiently serialized to the client from the server.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.LinkedHashMap<java.lang.Integer,MenuDescription>	descriptions Descriptions of immediate child containers
private int	menuId Root menu ID.
private boolean	suppressRedraw Suppress redraw on push of menu description.
private java.util.LinkedHashMap<java.lang.Integer,WidgetConfig>	widgets The widget configuration data.

Constructor Summary

Constructors

Constructor and Description
MenuDescription() Default constructor (only used for serialization).
MenuDescription(int id) The constructor creates a menu description with the given root frame ID.

Method Summary

Modifier and Type	Method and Description
void	addChildDescription(MenuDescription description, int widgetID) Add a widget configuration (to the current menu description) and assign that widget the specified ID.
void	addConfig(WidgetConfig config) Add a widget configuration to the current menu description.
void	addConfig(WidgetConfig config, int widgetID) Add a widget configuration (to the current menu description) and assign that widget the specified ID.
private void	addConfigInt(WidgetConfig config) Common worker to add a widget configuration to the menu description.
MenuDescription[]	getChildDescrArray() Get an array of all sub-descriptions inside this menu description.
WidgetConfig	getConfig(int id) Gets a specific widget configuration instance for the widget with the ID provided.
java.util.Iterator<WidgetConfig>	getConfigsIterator() Get an iterator to enumerate all widget configurations inside this menu description.
int	getRootMenuID() Get the root menu ID.
java.util.ArrayList<java.lang.Integer>	getWidgetsInMenu(int menuId) Gets an array of all immediate widget IDs in a given menu.
boolean	isSuppressRedraw() Get current value of 'suppress redraw' flag.
void	readExternal(java.io.ObjectInput in) Replacement for the default object reading method.
void	removeConfig(WidgetConfig config) Removes a widget configuration from the current menu description.
void	setSuppressRedraw(boolean suppressRedraw) Set new value for 'suppress redraw' flag.
void	writeExternal(java.io.ObjectOutput out) Replacement for the default object writing method.

Methods inherited from class java.lang.Object

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

Field Detail

widgets

private java.util.LinkedHashMap<java.lang.Integer,WidgetConfig> widgets

The widget configuration data.

descriptions

private java.util.LinkedHashMap<java.lang.Integer,MenuDescription> descriptions

Descriptions of immediate child containers

menuId

private int menuId

Root menu ID.

suppressRedraw

private boolean suppressRedraw

Suppress redraw on push of menu description.

Constructor Detail

MenuDescription

public MenuDescription()

Default constructor (only used for serialization).

MenuDescription

public MenuDescription(int id)

The constructor creates a menu description with the given root frame ID.

Parameters:

id - Identifies the root frame (or the only frame if this is not going to hold the configuration of a frame family).

Method Detail

getRootMenuID

public int getRootMenuID()

Get the root menu ID.

Returns:

The root menu ID.

getWidgetsInMenu

public java.util.ArrayList<java.lang.Integer> getWidgetsInMenu(int menuId)

Gets an array of all immediate widget IDs in a given menu.

Parameters:

menuId - ID of the menu for which widget IDs are requested.

Returns:

The list of all widget IDs for the specified menu.

getConfigsIterator

public java.util.Iterator<WidgetConfig> getConfigsIterator()

Get an iterator to enumerate all widget configurations inside this menu description.

Returns:

The iterator.

getChildDescrArray

public MenuDescription[] getChildDescrArray()

Get an array of all sub-descriptions inside this menu description.

Returns:

The array.

getConfig

public WidgetConfig getConfig(int id)

Gets a specific widget configuration instance for the widget with the ID provided.

Parameters:

id - The widget ID.

Returns:

The requested widget configuration object if exists, null otherwise.

addConfig

public void addConfig(WidgetConfig config)

Add a widget configuration to the current menu description.

Parameters:

config - New config to be added to the current menu description.

addConfig

public void addConfig(WidgetConfig config,
                      int widgetID)

Add a widget configuration (to the current menu description) and assign that widget the specified ID.

Parameters:

config - New config to be added to the current menu description.

widgetID - Widget ID.

addChildDescription

public void addChildDescription(MenuDescription description,
                                int widgetID)

Add a widget configuration (to the current menu description) and assign that widget the specified ID.

Parameters:

description - New child container description

widgetID - Child container ID.

removeConfig

public void removeConfig(WidgetConfig config)

Removes a widget configuration from the current menu description.

Parameters:

config - The config to be removed from the current menu description.

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Replacement for the default object reading method. The latest state is read from the input source.

Specified by:

readExternal in interface java.io.Externalizable

Parameters:

in - The input source from which fields will be restored.

Throws:

java.io.IOException - In case of I/O errors.

java.lang.ClassNotFoundException - If pay-load can't be instantiated.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Replacement for the default object writing method. The latest state is written to the output destination.

Specified by:

writeExternal in interface java.io.Externalizable

Parameters:

out - The output destination to which fields will be saved.

Throws:

java.io.IOException - In case of I/O errors.

setSuppressRedraw

public void setSuppressRedraw(boolean suppressRedraw)

Set new value for 'suppress redraw' flag.

Parameters:

suppressRedraw - New value of flag.

isSuppressRedraw

public boolean isSuppressRedraw()

Get current value of 'suppress redraw' flag.

Returns:

The current value of the flag.

addConfigInt

private void addConfigInt(WidgetConfig config)

Common worker to add a widget configuration to the menu description.

Parameters:

config - Widget configuration.