|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.plumtree.xpshared.htmlelements.HTMLElement com.plumtree.xpshared.htmlelements.HTMLGenericInputElement com.plumtree.xpshared.htmlelements.HTMLSelect
public class HTMLSelect
This class can be used to obtain a String describing an HTML SELECT element.
Spec
This class extends HTMLGeneralInputElement. This means that objects of
this class can be used to set name/value pairs within an HTML FORM.
This class also implements TabableHTMLElement. This means that this class
can generate a tabindex property that helps to guide the clients browser as
the client tabs through form elements.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class com.plumtree.xpshared.htmlelements.HTMLElement |
---|
HTMLElement.ValidationLevel |
Field Summary |
---|
Fields inherited from class com.plumtree.xpshared.htmlelements.HTMLElement |
---|
aNewLine, bAllowEvents, bAllowSetStyleClassWithString, bCheckNestedStringForHTML, bDisplayDidPause, bEnforceMaxTableDepth, bForceFormattingOff, bForceFormattingOn, bPauseAfterDisplay, bPrintComments, bResumingAndChildFinished, bResumingAndChildInMidRender, bShowLang, iMaxTableDepth, sLangLocal, sNewLine, sTab |
Constructor Summary | |
---|---|
HTMLSelect(java.lang.String sTagName,
java.lang.String sTagID)
|
Method Summary | |
---|---|
void |
AddInnerHTMLElement(HTMLElement e)
HTMLElement.addInnerHTMLElement rewritten. |
protected void |
AppendBeginningOfOpeningTag(boolean bFormat,
XPStringBuilder sb,
IXPResponse response)
This method generates the beginning of the opening tag. |
protected void |
AppendClosingTag(boolean bFormat,
XPStringBuilder sb,
IXPResponse response)
This method generates the closing tag of this html element. |
void |
ClearTabIndex()
Call this method to remove the tab index from this HTMLElement. |
boolean |
GetDoSort()
Call this method to determine whether or not this select sorts its contents immediately before display. |
java.lang.String |
GetSize()
|
java.lang.String |
GetTabIndex()
Call this method to get the value of the tabindex attribute. |
protected boolean |
ProvidesClosingTag()
Indicates whether or not this HTML element provides a closing tag. |
void |
SetDoSort(boolean b)
Call this method to specify whether or not this select will sort its nested options before each display. |
protected void |
SetHTMLElementReadOnly(boolean bReadOnly)
This method sets the element to read only and prepares for display, if bReadOnly is true. |
void |
SetMultiple(boolean bIsMultiple)
Call this method to set the multiple attribute. |
void |
SetSize(int i)
Call this method to set the size attribute value. |
void |
SetSize(java.lang.String s)
Call this method to set the size attribute value. |
void |
SetTabIndex(java.lang.String s)
Call this method to set the value of the tabindex attribute. |
void |
SetValue(java.lang.String s)
Call this method to set the value attribute value. |
void |
ValidateName(java.lang.String s)
Check to see if a name string is valid. |
Methods inherited from class com.plumtree.xpshared.htmlelements.HTMLGenericInputElement |
---|
GetOnBlur, GetOnChange, GetOnFocus, GetValue, SetName, SetOnBlur, SetOnChange, SetOnFocus, SetValidateName |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public HTMLSelect(java.lang.String sTagName, java.lang.String sTagID)
sTagName
- Pass the name of this select.sTagID
- Pass the id of this select.
HTMLException
Method Detail |
---|
protected void SetHTMLElementReadOnly(boolean bReadOnly)
SetHTMLElementReadOnly
in class HTMLElement
public void SetDoSort(boolean b)
b
- boolean To sort or notpublic boolean GetDoSort()
public java.lang.String GetSize()
public java.lang.String GetTabIndex()
TabableHTMLElement
GetTabIndex
in interface TabableHTMLElement
public void SetMultiple(boolean bIsMultiple)
bIsMultiple
- boolean valuepublic void SetSize(int i)
i
- int size.public void SetSize(java.lang.String s)
s
- sizepublic void SetTabIndex(java.lang.String s)
TabableHTMLElement
SetTabIndex
in interface TabableHTMLElement
s
- public void SetValue(java.lang.String s)
SetValue
in class HTMLGenericInputElement
s
- String value
HTMLException
- This method throws an exception if there is no
nested HTMLOption object having the specified value, or if this
element is read only.public void AddInnerHTMLElement(HTMLElement e)
AddInnerHTMLElement
in class HTMLElement
e
- Pass an HTMLOption object or an HTMLElementCollection object. If this
HTMLSelect sorts its nested children, then each nested HTMLElementCollection
will be independantly sorted. These HTMLElementCollection objects must contain
exclusively HTMLOption objects. HTMLOption objects nested directly will not
be sorted under any circumstances.
HTMLException
- This method throws an exception if you don't pass
an HTMLOption object or a collection of HTMLOptions.public void ClearTabIndex()
TabableHTMLElement
ClearTabIndex
in interface TabableHTMLElement
public void ValidateName(java.lang.String s)
ValidateName
in class HTMLGenericInputElement
s
- Name string.
HTMLException
- Throws an exception if the name passed isn't
valid.protected void AppendBeginningOfOpeningTag(boolean bFormat, XPStringBuilder sb, IXPResponse response)
AppendBeginningOfOpeningTag
in class HTMLElement
bFormat
- boolean indicating whether or not to format.sb
- XPStringBuilderresponse
- IXPResponseprotected void AppendClosingTag(boolean bFormat, XPStringBuilder sb, IXPResponse response)
AppendClosingTag
in class HTMLElement
bFormat
- boolean indicating whether or not to format.sb
- XPStringBuilderresponse
- IXPResponseprotected boolean ProvidesClosingTag()
ProvidesClosingTag
in class HTMLElement
|
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |