amber.server.component
Class CheckboxMenuItemHandler

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

All Implemented Interfaces:

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

public class CheckboxMenuItemHandler

extends MenuItemHandler

implements java.awt.ItemSelectable

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

Version:

1.0.0

Author:

Dr. David J. Knowles

See Also:

ApplicationInterface, ComponentHandler, Serialized Form

Inner classes inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent

Field Summary

protected boolean

state

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

CheckboxMenuItemHandler()
Create an off check box menu item with an empty label.

CheckboxMenuItemHandler(ApplicationInterface pageHandler)
The initialising constructor.

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

CheckboxMenuItemHandler(ApplicationInterface pageHandler, java.lang.String label, boolean state)
The initialising constructor.

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

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

CheckboxMenuItemHandler(int id, ApplicationInterface pageHandler, java.lang.String label, boolean state)
The initialising constructor.

Method Summary

java.lang.String	getPanelType() This function returns the panel component to use with this class.
java.lang.Object[]	getSelectedObjects() Returns the an array (length 1) containing the checkbox menu item label or null if the checkbox is not selected.
boolean	getState() Returns the state of the check item.
java.lang.String	paramString() Returns the parameter string representing the state of this check box menu item.
void	setState(boolean state) Sets this state of the menu item.

Methods inherited from class amber.server.component.MenuItemHandler

deleteShortcut, getLabel, getShortcut, getShortcutMenuItem, isEnabled, setEnabled, setLabel, setShortcut

Methods inherited from class amber.server.component.MenuComponentHandler

getId, getIdBaseOffset, getMenuParent, getName, getTopMenuParent, isMyId, 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, getDefaultParameters, getEventMask, getFontCharacteristics, getFontCharacteristics, getFontCharacteristics, getFontCharacteristics, getFontStyle, getLocation, getLog, getModalObject, getParentApplication, getParentContainer, getParentServer, getResponsePacket, getSize, getTimeout, getValidId, getX, getY, handleMessages, handlePacket, internalForwardPacket, internalGetBounds, intToBoolean, isActive, isApplicationActive, isComponentModal, isConnected, isVisible, processActionEvent, processComponentEvent, processCurrentPacket, processEvent, processFocusEvent, processItemEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processNormalResponse, processTextEvent, queryMessageBox, removeActionListener, removeComponentListener, removeEventMask, removeFocusListener, removeItemListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeNotify, removeTextListener, removeWindowListener, requestFocus, resetState, restart, sendPendingPackets, setActionCommand, setActive, 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 java.awt.ItemSelectable

addItemListener, removeItemListener

Field Detail

state

protected boolean state

Constructor Detail

CheckboxMenuItemHandler

public CheckboxMenuItemHandler()

Create an off check box menu item with an empty label.

CheckboxMenuItemHandler

public CheckboxMenuItemHandler(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.

CheckboxMenuItemHandler

public CheckboxMenuItemHandler(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.

CheckboxMenuItemHandler

public CheckboxMenuItemHandler(ApplicationInterface pageHandler,
                               java.lang.String label,
                               boolean state)

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.

state - The state of the item either on or off.

CheckboxMenuItemHandler

public CheckboxMenuItemHandler(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.

CheckboxMenuItemHandler

public CheckboxMenuItemHandler(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.

CheckboxMenuItemHandler

public CheckboxMenuItemHandler(int id,
                               ApplicationInterface pageHandler,
                               java.lang.String label,
                               boolean state)

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.

state - The state of the item either on or off.

Method Detail

getState

public boolean getState()

Returns the state of the check item.

Returns:

boolean state of the check item.

setState

public void setState(boolean state)

Sets this state of the menu item.

Parameters:

state - boolean state on or off for the item.

getSelectedObjects

public java.lang.Object[] getSelectedObjects()

Returns the an array (length 1) containing the checkbox menu item label or null if the checkbox is not selected.

Specified by:

getSelectedObjects in interface java.awt.ItemSelectable

Overrides:

getSelectedObjects in class ComponentHandler

See Also:

ItemSelectable

paramString

public java.lang.String paramString()

Returns the parameter string representing the state of this check box menu item. This string is useful for debugging.

Overrides:

paramString in class MenuItemHandler

Returns:

the parameter string of this check box menu item.

getPanelType

public java.lang.String getPanelType()

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

Overrides:

getPanelType in class MenuItemHandler

Returns:

String containing the panel type to use.