amber.server.component
Class PopupMenuHandler

java.lang.Object
  |
  +--java.awt.Component
        |
        +--amber.server.component.ComponentHandler
              |
              +--amber.server.component.MenuComponentHandler
                    |
                    +--amber.server.component.MenuItemHandler
                          |
                          +--amber.server.component.MenuHandler
                                |
                                +--amber.server.component.PopupMenuHandler

All Implemented Interfaces:

ApplicationInterface, BaseMenu, java.awt.image.ImageObserver, java.awt.ItemSelectable, MenuContainer, java.awt.MenuContainer, java.io.Serializable

public class PopupMenuHandler

extends MenuHandler

implements BaseMenu, java.io.Serializable

This class corresponds to a standard java.awt.Menu component. It differs in terms of being Amber aware. For this reason the component communicates with the remote client to perform the standard operations.

The remote client class also responds to information stored in the parameters field of the XYConstraints object when this handler is added to a panel. The allowed parameters are separated in the string by '|' characters. Any unused trailing parameters are optional and will assume default values, however the parameter order is fixed.

For example, if the component takes 4 parameters which are ints, a valid parameter string would be:

"1|2|3"

In this case the fourth parameter would assume the default value.

The parameter elements for this component are:

Component Parameters

Name	Type	Description	Repeats	Default
Menu Type	int	For this class the value MUST BE 0	No	0
Menu Label	int	The label of the menu	No

Version:

1.0.0

Author:

Dr. David J. Knowles

See Also:

ApplicationInterface, ComponentHandler, XYConstraints, Serialized Form

Inner classes inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent

Fields inherited from class amber.server.component.MenuHandler

items, tearOff

Fields inherited from class amber.server.component.MenuItemHandler

actionCommand, enabled, label

Fields inherited from class amber.server.component.MenuComponentHandler

name, parent

Fields inherited from class amber.server.component.ComponentHandler

active, ApplicationId, CancelReturn, dataEncoder, DefaultTimeout, enabledState, encoderBytes, id, InvalidId, MaximumId, NoReturn, OkCancelType, OkReturn, OkType, OkYesReturn, parentPage, responsePackets, timeoutValue, UnchangeableInvalidId, visibleState, YesNoCancelType, YesNoType, YesReturn

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

PopupMenuHandler()
Default constructor.

PopupMenuHandler(ApplicationInterface pageHandler)
The initialising constructor.

PopupMenuHandler(ApplicationInterface pageHandler, java.lang.String label)
The initialising constructor.

PopupMenuHandler(int id, ApplicationInterface pageHandler)
The initialising constructor.

PopupMenuHandler(int id, ApplicationInterface pageHandler, java.lang.String label)
The initialising constructor.

Method Summary

int	getBaseOffset() This function returns the base offset that all menu components off this menu must reference.
java.lang.String	getDefaultParameters() This function returns the default parameters string required by the component.
int	getIdOffset(int id) This function returns what the input ID would be if it were offset by the base offset.
java.lang.String	getPanelType() This function returns the panel component to use with this class.
int	removeIdOffset(int id) This function returns what the input ID would be if it were not offset by the base offset.
void	show(int x, int y) Shows the popup menu at the x, y position relative to the parent container.

Methods inherited from class amber.server.component.MenuHandler

add, add, addSeparator, deleteShortcut, deleteShortcut, forwardPacket, getItem, getItemCount, getShortcutMenuItem, insert, insert, insertSeparator, isMyId, isTearOff, paramString, processCurrentPacket, remove, remove, removeAll, resetState, setActive

Methods inherited from class amber.server.component.MenuItemHandler

getLabel, getShortcut, isEnabled, setEnabled, setLabel, setShortcut

Methods inherited from class amber.server.component.MenuComponentHandler

getId, getIdBaseOffset, getMenuParent, getName, getTopMenuParent, removeIdBaseOffset, sendPacket, sendPacketAndBlock, setName, toString

Methods inherited from class amber.server.component.ComponentHandler

addActionListener, addComponentListener, addEventMask, addFocusListener, addItemListener, addKeyListener, addMouseListener, addMouseMotionListener, addNotify, addReceivedPacket, addTextListener, addWindowListener, booleanToInt, createDataInput, directPacket, displayMessageBox, fireWindowActivated, fireWindowClosed, fireWindowClosing, fireWindowDeactivated, fireWindowDeiconified, fireWindowEvent, fireWindowIconified, fireWindowOpened, forceComponentGetUrl, forceComponentGetUrl, forwardEventPacket, generateActionEvent, generateFocusEvent, generateItemEvent, generateKeyEvent, generateMouseEvent, getActionCommand, getBounds, getComponentStructure, getEventMask, getFontCharacteristics, getFontCharacteristics, getFontCharacteristics, getFontCharacteristics, getFontStyle, getLocation, getLog, getModalObject, getParentApplication, getParentContainer, getParentServer, getResponsePacket, getSelectedObjects, getSize, getTimeout, getValidId, getX, getY, handleMessages, handlePacket, internalForwardPacket, internalGetBounds, intToBoolean, isActive, isApplicationActive, isComponentModal, isConnected, isVisible, processActionEvent, processComponentEvent, processEvent, processFocusEvent, processItemEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processNormalResponse, processTextEvent, queryMessageBox, removeActionListener, removeComponentListener, removeEventMask, removeFocusListener, removeItemListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeNotify, removeTextListener, removeWindowListener, requestFocus, restart, sendPendingPackets, setActionCommand, setBackground, setComponentModal, setConnectedState, setCursor, setEventMask, setFont, setFont, setFontStyle, setForeground, setForegroundBackground, setId, setLog, setModalObject, setParentApplication, setParentContainer, setParentServer, setTimeout, setVisible, setX, setY, shutDown, shutDownClient, shutDownClient, start

Methods inherited from class java.awt.Component

action, add, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addPropertyChangeListener, addPropertyChangeListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, deliverEvent, disable, disableEvents, dispatchEvent, doLayout, enable, enable, enableEvents, enableInputMethods, firePropertyChange, getAccessibleContext, getAlignmentX, getAlignmentY, getBackground, getBounds, getColorModel, getComponentAt, getComponentAt, getComponentOrientation, getCursor, getDropTarget, getFont, getFontMetrics, getForeground, getGraphics, getGraphicsConfiguration, getHeight, getInputContext, getInputMethodRequests, getListeners, getLocale, getLocation, getLocationOnScreen, getMaximumSize, getMinimumSize, getParent, getPeer, getPreferredSize, getSize, getToolkit, getTreeLock, getWidth, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, invalidate, isDisplayable, isDoubleBuffered, isFocusTraversable, isLightweight, isOpaque, isShowing, isValid, keyDown, keyUp, layout, list, list, list, list, list, locate, location, lostFocus, minimumSize, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paint, paintAll, postEvent, preferredSize, prepareImage, prepareImage, print, printAll, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, remove, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, reshape, resize, resize, setBounds, setBounds, setComponentOrientation, setDropTarget, setLocale, setLocation, setLocation, setSize, setSize, show, show, size, transferFocus, update, validate

Methods inherited from class java.lang.Object

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

Methods inherited from interface amber.server.component.MenuContainer

getFont

Constructor Detail

PopupMenuHandler

public PopupMenuHandler()

Default constructor.

PopupMenuHandler

public PopupMenuHandler(ApplicationInterface pageHandler)

The initialising constructor. This constructor dynamically requests a valid ID value from the ApplicationInterface.

Parameters:

pageHandler - The handle to the main ApplicationInterface which handles the functions of page overall. residing on the browser.

PopupMenuHandler

public PopupMenuHandler(ApplicationInterface pageHandler,
                        java.lang.String label)

The initialising constructor. This constructor dynamically requests a valid ID value from the ApplicationInterface.

Parameters:

pageHandler - The handle to the main ApplicationInterface which handles the functions of page overall. residing on the browser.

label - The label for this menu item.

PopupMenuHandler

public PopupMenuHandler(int id,
                        ApplicationInterface pageHandler)

The initialising constructor.

Parameters:

id - The int containing the id of the corresponding remote component residing on the browser.

pageHandler - The handle to the main ApplicationInterface which handles the functions of page overall.

PopupMenuHandler

public PopupMenuHandler(int id,
                        ApplicationInterface pageHandler,
                        java.lang.String label)

The initialising constructor.

Parameters:

id - The int containing the id of the corresponding remote component residing on the browser.

pageHandler - The handle to the main ApplicationInterface which handles the functions of page overall.

label - The label for this menu item.

Method Detail

show

public void show(int x,
                 int y)

Shows the popup menu at the x, y position relative to the parent container.

Parameters:

x - the x coordinate position to popup the menu

y - the y coordinate position to popup the menu

getBaseOffset

public int getBaseOffset()

This function returns the base offset that all menu components off this menu must reference.

Specified by:

getBaseOffset in interface BaseMenu

Returns:

int containing the base offset.

getIdOffset

public int getIdOffset(int id)

This function returns what the input ID would be if it were offset by the base offset.

Specified by:

getIdOffset in interface BaseMenu

Parameters:

id - int ID value to offset.

Returns:

int containing the ID value offset by the base offset.

removeIdOffset

public int removeIdOffset(int id)

This function returns what the input ID would be if it were not offset by the base offset.

Specified by:

removeIdOffset in interface BaseMenu

Parameters:

id - int ID value including offset.

Returns:

int containing the ID value with no base offset.

getDefaultParameters

public java.lang.String getDefaultParameters()

This function returns the default parameters string required by the component. This is rarely used but may be overridden for a panel component to always have a particular type of parameter when creating the component at the client. This is overriden to tell the client to create a Pop-Up menu component (this is also the default).

Overrides:

getDefaultParameters in class ComponentHandler

Returns:

String containing the parameters value to use.

getPanelType

public java.lang.String getPanelType()

This function returns the panel component to use with this class.

Overrides:

getPanelType in class MenuHandler

Returns:

String containing the panel type to use.