com.aspc.remote.html

Class HTMLListBox

java.lang.Object

com.aspc.remote.html.HTMLComponent

com.aspc.remote.html.internal.HTMLFormComponent

com.aspc.remote.html.HTMLListBox

All Implemented Interfaces:

HTMLReadOnly, HTMLReadOnlyToggle

public class HTMLListBox
extends HTMLFormComponent
implements HTMLReadOnlyToggle

HTMLListBox THREAD MODE: SINGLE-THREADED HTML generator component

Since:

23 May 1998

Author:

Nigel Leck

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	allowMultiple Is this disabled
protected boolean	disabledFg Is this disabled
protected boolean	forceEnabled Is this disabled
protected java.util.ArrayList<java.lang.String>	listCodes the codes.
protected java.util.ArrayList<java.lang.String>	listItems the items
protected boolean	readonlyFg Is this disabled
protected java.util.HashMap<java.lang.String,java.lang.String>	selectedItems The selected item
static java.lang.String	SEPERATOR_VALUE

Fields inherited from class com.aspc.remote.html.internal.HTMLFormComponent

STYLE_STS_FIELD, STYLE_STS_FIELD_IN_TABLE, STYLE_STS_FIELD_PRINTOUT

Fields inherited from class com.aspc.remote.html.HTMLComponent

alignment, alt, bgColor, cancelBubble, events, gMutableTheme, hasInitFocus, id, intStyleSheet, items, name, parent, styleId, styleProperty, tabIndex, toolTip, VALID_NAME_REGEX, VALID_STYLE_REGEX

Constructor Summary

Constructors

Constructor and Description
HTMLListBox(java.lang.String name)

Method Summary

Modifier and Type	Method and Description
void	addItem(java.lang.String itemName)
void	addItem(java.lang.String itemName, boolean selected)
void	addItem(java.lang.String itemName, java.lang.String itemCode)
void	addItem(java.lang.String itemName, java.lang.String itemCode, boolean selected)
void	addOnChangeEvent(java.lang.String call)
void	addOnChangeEvent(java.lang.String call, java.lang.String script)
void	addSeperator()
protected void	compile(ClientBrowser browser) This is the spot to put all your generation of the HTML components.
void	forceEnabled()
int	getIndex(java.lang.String itemCode)
java.lang.String	getItemCode(int index)
java.lang.String	getItemValue(int index)
java.lang.String	getName()
int	getNumberOfItems()
java.lang.String	getPlaceHolder() get the placeholder string
int	getSize()
java.lang.String	getValue()
boolean	hasValue(java.lang.String itemCode) Does the list contain this code.
protected void	iGenerate(ClientBrowser browser, java.lang.StringBuilder buffer) generate the raw HTML for this component.
protected void	iListBoxGenerate(ClientBrowser browser, java.lang.StringBuilder buffer)
void	insertItem(int index, java.lang.String itemName, java.lang.String itemCode, boolean selected)
boolean	isDisabled() Is this is Disabled
boolean	isReadOnly() Is this is ReadOnly
void	removeAllItems() remove all items.
void	removeItem(int index)
void	setAllowMultiple(boolean on)
void	setDisabled(boolean flag) Disables this list box.
void	setPlaceHolder(java.lang.String plSring) set the placeholder string
void	setReadOnly(boolean flag) Sets the field to READONLY.
void	setSelected(java.lang.String itemCode)
void	setSelected(java.lang.String itemCode, boolean on)
void	setSize(int size)
void	setToolTip(java.lang.String toolTip)
void	setValue(java.lang.String value)
void	setVisible(boolean visible)

Methods inherited from class com.aspc.remote.html.HTMLComponent

addJavaScript, addJavaScript, addOnLoadScript, appendClassName, checkIsContainer, copyAttributes, doBuildToolTip, fetchStyleProperty, getClassName, getId, getMutableTheme, getParent, getParentPage, getStyleSheet, getTheme, hasTheme, iAddComponent, iAddComponent, iAddedToPage, iAddEvent, iClear, iFindId, iGenerateAttributes, iGenerateAttributesID, iGenerateComponent, iGenerateComponent, iGenerateEvents, iGetComponent, iGetComponentCount, iHasEvent, iRemoveComponent, isCompiled, iSetId, iSetName, iSetStyleId, makeColorID, makeListOfEvents, monitorPage, postCompile, resetParent, setAlignment, setAttribute, setClassName, setHasInitFocus, setParent, setStyleProperty, setTabIndex, touch

Methods inherited from class java.lang.Object

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

Field Detail

SEPERATOR_VALUE

public static final java.lang.String SEPERATOR_VALUE

See Also:

Constant Field Values

disabledFg

protected boolean disabledFg

Is this disabled

readonlyFg

protected boolean readonlyFg

Is this disabled

forceEnabled

protected boolean forceEnabled

Is this disabled

allowMultiple

protected boolean allowMultiple

Is this disabled

selectedItems

protected java.util.HashMap<java.lang.String,java.lang.String> selectedItems

The selected item

listItems

protected java.util.ArrayList<java.lang.String> listItems

the items

listCodes

protected java.util.ArrayList<java.lang.String> listCodes

the codes.

Constructor Detail

HTMLListBox

public HTMLListBox(java.lang.String name)

Parameters:

name -

Method Detail

setPlaceHolder

public void setPlaceHolder(java.lang.String plSring)

set the placeholder string

Parameters:

plSring - the place holder string

getPlaceHolder

public java.lang.String getPlaceHolder()

get the placeholder string

Returns:

the place holder string

getNumberOfItems

public int getNumberOfItems()

Returns:

the value

addOnChangeEvent

public void addOnChangeEvent(java.lang.String call)

Specified by:

addOnChangeEvent in class HTMLFormComponent

Parameters:

call -

addOnChangeEvent

public void addOnChangeEvent(java.lang.String call,
                             java.lang.String script)

Specified by:

addOnChangeEvent in class HTMLFormComponent

Parameters:

call -

script -

addItem

public void addItem(java.lang.String itemName)

Parameters:

itemName -

addItem

public void addItem(java.lang.String itemName,
                    java.lang.String itemCode)

Parameters:

itemName -

itemCode -

setSelected

public void setSelected(java.lang.String itemCode)

Parameters:

itemCode -

setSelected

public void setSelected(java.lang.String itemCode,
                        boolean on)

Parameters:

itemCode -

on -

setAllowMultiple

public void setAllowMultiple(boolean on)

Parameters:

on -

setVisible

public void setVisible(boolean visible)

Parameters:

visible -

hasValue

public boolean hasValue(java.lang.String itemCode)

Does the list contain this code.

Parameters:

itemCode -

Returns:

the value

setSize

public void setSize(int size)

Parameters:

size -

getSize

public int getSize()

Returns:

the value

addItem

public void addItem(java.lang.String itemName,
                    boolean selected)

Parameters:

itemName -

selected -

addItem

public void addItem(java.lang.String itemName,
                    java.lang.String itemCode,
                    boolean selected)

Parameters:

itemName -

itemCode -

selected -

insertItem

public void insertItem(int index,
                       java.lang.String itemName,
                       java.lang.String itemCode,
                       boolean selected)

Parameters:

index -

itemName -

itemCode -

selected -

forceEnabled

public void forceEnabled()

setDisabled

public void setDisabled(boolean flag)

Disables this list box.

Specified by:

setDisabled in interface HTMLReadOnlyToggle

Parameters:

flag -

addSeperator

public void addSeperator()

setToolTip

public void setToolTip(java.lang.String toolTip)

Parameters:

toolTip -

iGenerate

protected void iGenerate(ClientBrowser browser,
                         java.lang.StringBuilder buffer)

generate the raw HTML for this component.

Overrides:

iGenerate in class HTMLComponent

Parameters:

browser - The target browser

buffer - The generate HTML

compile

protected void compile(ClientBrowser browser)

Description copied from class: HTMLComponent

This is the spot to put all your generation of the HTML components. Do not put it in iGenerate()

Overrides:

compile in class HTMLComponent

iListBoxGenerate

protected void iListBoxGenerate(ClientBrowser browser,
                                java.lang.StringBuilder buffer)

Parameters:

browser -

buffer -

getName

public java.lang.String getName()

Specified by:

getName in class HTMLFormComponent

Returns:

the value

getValue

public java.lang.String getValue()

Specified by:

getValue in class HTMLFormComponent

Returns:

the value

removeItem

public void removeItem(int index)

Parameters:

index -

removeAllItems

public void removeAllItems()

remove all items.

getItemValue

public java.lang.String getItemValue(int index)

Parameters:

index -

Returns:

the value

getItemCode

public java.lang.String getItemCode(int index)

Parameters:

index -

Returns:

the value

setValue

public void setValue(java.lang.String value)

Specified by:

setValue in class HTMLFormComponent

Parameters:

value - the value

getIndex

public int getIndex(java.lang.String itemCode)

Parameters:

itemCode -

Returns:

the value

setReadOnly

public void setReadOnly(boolean flag)

Sets the field to READONLY. READONLY is a little stronger than disabled as it can on be turned back on in the browser via javascript.

Specified by:

setReadOnly in interface HTMLReadOnlyToggle

Parameters:

flag -

isDisabled

public boolean isDisabled()

Is this is Disabled

Specified by:

isDisabled in interface HTMLReadOnly

Returns:

TRUE if disabled

isReadOnly

public boolean isReadOnly()

Is this is ReadOnly

Specified by:

isReadOnly in interface HTMLReadOnly

Returns:

TRUE if readonly