amber.server.component
Class ChoiceHandler

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

All Implemented Interfaces:

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

public class ChoiceHandler

extends ComponentHandler

implements java.io.Serializable

This class handles the requirements for the manipulation of the packets moving to and from a choice component. It is designed to look like a standard choice control and interacts with the ApplicationInterface as if the choice 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
Item	String	An item in the list	Yes

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	AddStrings
static byte	ChangeSelection
static byte	ClearAndFillChoice
static byte	ClearChoice
static byte	DeleteString
static byte	GetSelectedIndex
static byte	GetSelectedIndexResponse
static byte	GetSelectedString
static byte	GetSelectedStringResponse
static byte	InsertString
protected java.util.Vector	items
static byte	SelectString

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

ChoiceHandler()
Default constructor.

ChoiceHandler(ApplicationInterface pageHandler)
The initialising constructor.

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

Method Summary

void	add(java.lang.String item) Adds a string to the items in the choice.
void	addItem(java.lang.String item) Adds a string to the items in the choice.
java.lang.String	getItem(int index) Returns the item associated with the specified index.
int	getItemCount() Returns the number of items in the list.
java.lang.String[]	getItems() Returns the items in the list as an array of strings.
java.lang.String	getPanelType() This function returns the panel component to use with this class.
int	getSelectedIndex() Returns the index of the selected item in the choice.
java.lang.String	getSelectedItem() Returns the selected item in the choice.
void	insert(java.lang.String item, int index) Adds a string to the items in the choice.
void	remove(int position) Remove the specified item from the list in the choice.
void	removeAll() Remove all items from the list in the choice.
void	select(int index) Selects the specified index in the choice.
void	select(java.lang.String value) Selects the specified item in the choice.
void	setSelectedItem(java.lang.String item) Selects the specified string in the list.

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

ClearChoice

public static final byte ClearChoice

AddStrings

public static final byte AddStrings

ClearAndFillChoice

public static final byte ClearAndFillChoice

GetSelectedIndex

public static final byte GetSelectedIndex

GetSelectedIndexResponse

public static final byte GetSelectedIndexResponse

GetSelectedString

public static final byte GetSelectedString

GetSelectedStringResponse

public static final byte GetSelectedStringResponse

InsertString

public static final byte InsertString

DeleteString

public static final byte DeleteString

ChangeSelection

public static final byte ChangeSelection

SelectString

public static final byte SelectString

items

protected java.util.Vector items

Constructor Detail

ChoiceHandler

public ChoiceHandler()

Default constructor.

ChoiceHandler

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

ChoiceHandler

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

add

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

Adds a string to the items in the choice. The string is added at the end of the list.

Parameters:

item - String to add to the list.

Throws:

ComponentHandlerException - with any messaging errors.

insert

public void insert(java.lang.String item,
                   int index)
            throws ComponentHandlerException

Adds a string to the items in the choice. The string is inserted at the specified point in the list.

Parameters:

item - String to add to the list.

index - int index of where to add the string to the list.

Throws:

ComponentHandlerException - with any messaging errors.

addItem

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

Adds a string to the items in the choice. The string is added at the end of the list.

Parameters:

item - String to add to the list.

Throws:

ComponentHandlerException - with any messaging errors.

removeAll

public void removeAll()
               throws ComponentHandlerException

Remove all items from the list in the choice.

Throws:

ComponentHandlerException - with any messaging errors.

remove

public void remove(int position)
            throws ComponentHandlerException

Remove the specified item from the list in the choice.

Parameters:

index - int position of the string to remove in the list.

Throws:

ComponentHandlerException - with any messaging errors.

getSelectedIndex

public int getSelectedIndex()
                     throws ComponentHandlerException

Returns the index of the selected item in the choice.

Returns:

int containing the index of the selected item or -1 if no item is selected.

Throws:

ComponentHandlerException - with any messaging errors.

getSelectedItem

public java.lang.String getSelectedItem()
                                 throws ComponentHandlerException

Returns the selected item in the choice.

Returns:

String containing the text of the selected item or null if no item is selected.

Throws:

ComponentHandlerException - with any messaging errors.

select

public void select(int index)
            throws ComponentHandlerException

Selects the specified index in the choice.

Parameters:

index - int item number of the item to select.

Throws:

ComponentHandlerException - with any messaging errors.

select

public void select(java.lang.String value)
            throws ComponentHandlerException

Selects the specified item in the choice.

Parameters:

value - String which matches the item to select.

Throws:

ComponentHandlerException - with any messaging errors.

getItemCount

public int getItemCount()

Returns the number of items in the list.

Returns:

int number of items.

getItem

public java.lang.String getItem(int index)

Returns the item associated with the specified index.

Parameters:

index - int index of the item to get.

Returns:

String item associated with the index.

getItems

public java.lang.String[] getItems()

Returns the items in the list as an array of strings.

Returns:

String [] items in the list.

setSelectedItem

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

Selects the specified string in the list.

Parameters:

item - String item to select in the list.

Throws:

ComponentHandlerException - containing the error information.

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.