amber.server.component
Class ButtonHandler

java.lang.Object
  |
  +--java.awt.Component
        |
        +--amber.server.component.ComponentHandler
              |
              +--amber.server.component.ButtonHandler

All Implemented Interfaces:

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

Direct Known Subclasses:

FloatButtonHandler

public class ButtonHandler

extends ComponentHandler

implements java.io.Serializable

This class handles the requirements for the manipulation of the packets moving to and from a button component. It is designed to look like a standard button and interacts with the ApplicationInterface as if the button were running on the server rather than the Browser.

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
Caption	String	The caption displayed on the button	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

Field Summary

static byte	GetCaption
static byte	GetCaptionResponse
static byte	NextAvailableCommand
static byte	SetCaption

Fields inherited from class amber.server.component.ComponentHandler

actionCommand, 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

ButtonHandler()
Default constructor.

ButtonHandler(ApplicationInterface pageHandler)
The initialising constructor.

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

Method Summary

java.lang.String	getLabel() Returns the label displayed on the button.
java.lang.String	getPanelType() This function returns the panel component to use with this class.
void	setLabel(java.lang.String item) Sets the label displayed on the button.

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, getId, getLocation, getLog, getModalObject, getParentApplication, getParentContainer, getParentServer, getResponsePacket, getSelectedObjects, getSize, getTimeout, getValidId, getX, getY, handleMessages, handlePacket, internalForwardPacket, internalGetBounds, intToBoolean, isActive, isApplicationActive, isComponentModal, isConnected, isEnabled, isMyId, 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, sendPacket, sendPacketAndBlock, sendPendingPackets, setActionCommand, setActive, setBackground, setComponentModal, setConnectedState, setCursor, setEnabled, 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, getName, 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, paramString, 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, setName, setSize, setSize, show, show, size, toString, transferFocus, update, validate

Methods inherited from class java.lang.Object

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

Field Detail

SetCaption

public static final byte SetCaption

GetCaption

public static final byte GetCaption

GetCaptionResponse

public static final byte GetCaptionResponse

NextAvailableCommand

public static final byte NextAvailableCommand

Constructor Detail

ButtonHandler

public ButtonHandler()

Default constructor.

ButtonHandler

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

ButtonHandler

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

Method Detail

setLabel

public void setLabel(java.lang.String item)
              throws ComponentHandlerException

Sets the label displayed on the button.

Parameters:

item - String containing the label on the button.

Throws:

ComponentHandlerException - contains any errors performing this command.

getLabel

public java.lang.String getLabel()
                          throws ComponentHandlerException

Returns the label displayed on the button.

Returns:

String containing the label on the button or null if there is no label.

Throws:

ComponentHandlerException - contains any errors performing this command.

getPanelType

public java.lang.String getPanelType()

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

Overrides:

getPanelType in class ComponentHandler

Returns:

String containing the panel type to use.