amber.server.component
Class FloatButtonHandler

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

All Implemented Interfaces:

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

public class FloatButtonHandler

extends ButtonHandler

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
Enabled Image	URL	The URL of the image displayed when the button is enabled	No
Disabled Image	URL	The URL of the image displayed when the button is disabled	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	SetButtonState
static byte	SetDisabledImage
static byte	SetEnabledImage
static byte	SetIsToggleButton
static byte	SetLookAndFeel

Fields inherited from class amber.server.component.ButtonHandler

GetCaption, GetCaptionResponse, NextAvailableCommand, 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

FloatButtonHandler()
Default constructor.

FloatButtonHandler(ApplicationInterface pageHandler)
The initialising constructor.

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

Method Summary

java.lang.String	getPanelType() This function returns the panel component to use with this class.
void	setButtonDown() Sets the button state to be down by calling setButtonState
void	setButtonState(boolean buttonUp) Sets the button state (up/not selected or down/selected) This really only makes sense for toggle buttons
void	setButtonUp() Sets the button state to be down by calling setButtonState
void	setDisabledImage(java.lang.String image) Sets the image used when the button is disabled.
void	setEnabledImage(java.lang.String image) Sets the image used when the button is enabled.
void	setLookAndFeel(java.awt.Color buttonColour, java.awt.Color fontColour) Sets the colour of the button and the font.
void	setToggleButton(boolean isToggleButton) Sets whether or not this button is a toggle button.

Methods inherited from class amber.server.component.ButtonHandler

getLabel, setLabel

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

SetEnabledImage

public static final byte SetEnabledImage

SetDisabledImage

public static final byte SetDisabledImage

SetIsToggleButton

public static final byte SetIsToggleButton

SetButtonState

public static final byte SetButtonState

SetLookAndFeel

public static final byte SetLookAndFeel

Constructor Detail

FloatButtonHandler

public FloatButtonHandler()

Default constructor.

FloatButtonHandler

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

FloatButtonHandler

public FloatButtonHandler(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

setEnabledImage

public void setEnabledImage(java.lang.String image)
                     throws ComponentHandlerException

Sets the image used when the button is enabled.

Parameters:

image - String containing the URL name of the image file.

Throws:

ComponentHandlerException - containing error information.

setDisabledImage

public void setDisabledImage(java.lang.String image)
                      throws ComponentHandlerException

Sets the image used when the button is disabled.

Parameters:

image - String containing the URL name of the image file.

Throws:

ComponentHandlerException - containing error information.

setToggleButton

public void setToggleButton(boolean isToggleButton)
                     throws ComponentHandlerException

Sets whether or not this button is a toggle button. Toggle buttons stay pressed when they are clicked on - regular (non-toggle) buttons pop right back up

Parameters:

isToggleButton - True to make it a toggle button, false to make it regular

setButtonState

public void setButtonState(boolean buttonUp)
                    throws ComponentHandlerException

Sets the button state (up/not selected or down/selected) This really only makes sense for toggle buttons

Parameters:

buttonUp - True to make it a button popped up, false to make it depressed

setLookAndFeel

public void setLookAndFeel(java.awt.Color buttonColour,
                           java.awt.Color fontColour)
                    throws ComponentHandlerException

Sets the colour of the button and the font.

Parameters:

buttonColour - Color of the button.

fontColour - Color of the font in the button.

setButtonDown

public void setButtonDown()
                   throws ComponentHandlerException

Sets the button state to be down by calling setButtonState

setButtonUp

public void setButtonUp()
                 throws ComponentHandlerException

Sets the button state to be down by calling setButtonState

getPanelType

public java.lang.String getPanelType()

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

Overrides:

getPanelType in class ButtonHandler

Returns:

String containing the panel type to use.