| java.lang.Object
 com.salmonllc.html.HtmlComponent
com.salmonllc.html.HtmlFormComponent
com.salmonllc.html.HtmlListBox
| HtmlListBox | | public class HtmlListBox extends HtmlFormComponent (Code) | | This class is used to allow for the selection of items from a list.
|
| Method Summary | |
| public void | addOption(String key, String disp)
Use this method to add new choices to the list. | | public void | addOption(String key, String disp, boolean selected)
Use this method to add new choices to the list. | | public void | deselectAll()
| | public int | findOptionIndexOf(String key)
This method returns the index of the option with the specified key. | | public void | generateHTML(java.io.PrintWriter p, int rowNo)
| | public String | getAccessKey()
| | public String | getFontEndTag()
This method gets the end font tag for the component. | | public String | getFontStartTag()
This method gets the start font tag for the component. | | public boolean | getMulti()
This method returns whether or not the user can select multiple rows from the component. | | public String | getOnChange()
This method gets the javascript to be executed when the value of the text in the component changes. | | public String | getOnClick()
This method gets the javascript to be executed when the component is clicked on. | | public String | getOnFocus()
This method gets the javascript to be executed when the component gets focus. | | public String | getOnLoseFocus()
This method gets the javascript to be executed when the component loses focus. | | public int | getOptionCount()
This method returns the number of options in the component. | | public String | getOptionKey(int index)
Use this method get the value of the key at index. | | public boolean | getOptionSelected(int index)
Use this method to find out if an option is selected. | | public String | getOptionValue(int index)
Use this method get the value of the option at index. | | public String | getSelectedList(String separator)
| | public int | getSize()
This method gets the display size for the component in characters. | | public String | getStyle()
This method gets the property style (allows for the inlining of style attributes like color:#666666;) for the component. | | public int | getTabIndex()
| | public void | initialize(String table, String keyColumn, String dispColumn, String criteria, boolean inputVersion)
| | public void | initialize(String table, String keyColumn, String dispColumn, String criteria, boolean inputVersion, boolean trimResults)
| | public void | initialize(String table, String keyColumn, String dispColumn, String criteria, boolean inputVersion, boolean trimResults, boolean toUpper)
| | public boolean | processParms(Hashtable parms, int rowNo)
| | public void | removeOption(int index)
Use this method to remove an option from the list. | | public void | resetOptions()
This method removes all options from the component. | | public void | selectAll()
| | public void | setAccessKey(String string)
| | public void | setAll(boolean selected)
| | public void | setFontEndTag(String value)
This method sets the end font tag for the component. | | public void | setFontStartTag(String value)
This method sets the start font tag for the component. | | public void | setMulti(boolean multi)
This method sets the whether or not the user can select multiple rows from the component. | | public void | setOnChange(String value)
This method sets the javascript to be executed when the value of the text in the component changes. | | public void | setOnClick(String value)
This method sets the javascript to be executed when the component is clicked on. | | public void | setOnFocus(String value)
This method sets the javascript to be executed when the component gains focus. | | public void | setOnLoseFocus(String value)
This method sets the javascript to be executed when the component loses focus. | | public void | setOptionSelected(int index, boolean selected)
Use this method set whether an option is selected. | | public void | setOptionValue(int index, String value)
Use this method to set the value of the option at index. | | public void | setSize(int size)
This method sets the display size for the component in characters. | | public void | setStyle(String style)
This method sets the property style (allows for the inlining of style attributes like color:#666666;) for the component. | | public void | setTabIndex(int val)
Parameters:
val - sets the tab index html attribute. | | public void | setTheme(String theme)
This method sets the property theme for the component. | | public void | sort()
Claudio Pi (4-01-2003) This method sorts the dropdown list based on its options values in the default order direction. | | public void | sort(int dir)
Claudio Pi (4-01-2003) This method sorts the dropdown list based on its options values in the given order direction. |
| HtmlListBox | | public HtmlListBox(String name, com.salmonllc.html.HtmlPage p)(Code) | | Constructs a new HtmlListBox component.
Parameters:
name - The name of the component
Parameters:
p - The page the component will be placed in. |
| HtmlListBox | | public HtmlListBox(String name, String theme, com.salmonllc.html.HtmlPage p)(Code) | | Constructs a new HtmlListBox component.
Parameters:
name - The name of the component
Parameters:
theme - The theme to use for loading properties.
Parameters:
p - The page the component will be placed in. |
| HtmlListBox | | public HtmlListBox(String name, String theme, HtmlPage page, String table, String keyColumn, String dispColumn)(Code) | | Creates a list box based on a simple table with an
integer primary key column and a string column. Typically the integer is a type value
and the string is a description. A simplifying assumption is that each of the following
is the same:
- name of column in the main table which refers to the simple table
- name of integer column in simple table
Parameters:
name - DOCUMENT ME!
Parameters:
theme - DOCUMENT ME!
Parameters:
page - com.salmonllc.html.HtmlPage The page hold the new component
Parameters:
table - - name of table to look up keys and displays from
Parameters:
keyColumn - - column to get key values from
Parameters:
dispColumn - - column to get display values from |
| addOption | | public void addOption(String key, String disp)(Code) | | Use this method to add new choices to the list.
Parameters:
key - The internal name of the item (must be unique)
Parameters:
disp - The value to be displayed on the list. |
| addOption | | public void addOption(String key, String disp, boolean selected)(Code) | | Use this method to add new choices to the list.
Parameters:
key - The internal name of the item (must be unique)
Parameters:
disp - The value to be displayed on the list.
Parameters:
selected - DOCUMENT ME! |
| deselectAll | | public void deselectAll()(Code) | | Deselects all items in the list
|
| findOptionIndexOf | | public int findOptionIndexOf(String key)(Code) | | This method returns the index of the option with the specified key.
Parameters:
key - DOCUMENT ME! The index of the key or -1 if not found. |
| getAccessKey | | public String getAccessKey()(Code) | | the access key html attribute |
| getFontEndTag | | public String getFontEndTag()(Code) | | This method gets the end font tag for the component.
DOCUMENT ME! |
| getFontStartTag | | public String getFontStartTag()(Code) | | This method gets the start font tag for the component.
DOCUMENT ME! |
| getMulti | | public boolean getMulti()(Code) | | This method returns whether or not the user can select multiple rows from the component.
DOCUMENT ME! |
| getOnChange | | public String getOnChange()(Code) | | This method gets the javascript to be executed when the value of the text in the component changes.
DOCUMENT ME! |
| getOnClick | | public String getOnClick()(Code) | | This method gets the javascript to be executed when the component is clicked on.
DOCUMENT ME! |
| getOnFocus | | public String getOnFocus()(Code) | | This method gets the javascript to be executed when the component gets focus.
DOCUMENT ME! |
| getOnLoseFocus | | public String getOnLoseFocus()(Code) | | This method gets the javascript to be executed when the component loses focus.
DOCUMENT ME! |
| getOptionCount | | public int getOptionCount()(Code) | | This method returns the number of options in the component.
DOCUMENT ME! |
| getOptionKey | | public String getOptionKey(int index)(Code) | | Use this method get the value of the key at index.
Parameters:
index - DOCUMENT ME! DOCUMENT ME! |
| getOptionSelected | | public boolean getOptionSelected(int index)(Code) | | Use this method to find out if an option is selected.
Parameters:
index - DOCUMENT ME! DOCUMENT ME! |
| getOptionValue | | public String getOptionValue(int index)(Code) | | Use this method get the value of the option at index.
Parameters:
index - DOCUMENT ME! DOCUMENT ME! |
| getSelectedList | | public String getSelectedList(String separator)(Code) | | Returns a list of keys corresponding to the selected values
Parameters:
separator - DOCUMENT ME! java.lang.String |
| getSize | | public int getSize()(Code) | | This method gets the display size for the component in characters.
DOCUMENT ME! |
| getStyle | | public String getStyle()(Code) | | This method gets the property style (allows for the inlining of style attributes like color:#666666;) for the component.
DOCUMENT ME! |
| getTabIndex | | public int getTabIndex()(Code) | | the tab index html attribute |
| initialize | | public void initialize(String table, String keyColumn, String dispColumn, String criteria, boolean inputVersion)(Code) | | Creates a list box based on a table with an
integer primary key column (typically an id) and a string column.
A simplifying assumption is that each of the following
is the same:
- name of column in the main table which refers to the simple table
- name of integer column in simple table
Parameters:
table - - name of table to look up keys and displays from
Parameters:
keyColumn - - column to get key values from
Parameters:
dispColumn - - column to get display values from
Parameters:
criteria - - optional selection criteria
Parameters:
inputVersion - - optional value that allows for a null to be placed at the top |
| initialize | | public void initialize(String table, String keyColumn, String dispColumn, String criteria, boolean inputVersion, boolean trimResults)(Code) | | Creates a list box based on a table with an
integer primary key column (typically an id) and a string column.
A simplifying assumption is that each of the following
is the same:
- name of column in the main table which refers to the simple table
- name of integer column in simple table
Parameters:
table - - name of table to look up keys and displays from
Parameters:
keyColumn - - column to get key values from
Parameters:
dispColumn - - column to get display values from
Parameters:
criteria - - optional selection criteria
Parameters:
inputVersion - - optional value that allows for a null to be placed at the top
Parameters:
trimResults - - optional value that trims the rtesults before adding the options |
| initialize | | public void initialize(String table, String keyColumn, String dispColumn, String criteria, boolean inputVersion, boolean trimResults, boolean toUpper)(Code) | | Creates a list box based on a table with an
integer primary key column (typically an id) and a string column.
A simplifying assumption is that each of the following
is the same:
- name of column in the main table which refers to the simple table
- name of integer column in simple table
Parameters:
table - - name of table to look up keys and displays from
Parameters:
keyColumn - - column to get key values from
Parameters:
dispColumn - - column to get display values from
Parameters:
criteria - - optional selection criteria
Parameters:
inputVersion - - optional value that allows for a null to be placed at the top
Parameters:
trimResults - - optional value that trims the rtesults before adding the options
Parameters:
toUpper - - optional value that makes the option's kays and display values all upper case |
| removeOption | | public void removeOption(int index)(Code) | | Use this method to remove an option from the list.
Parameters:
index - The index of the option to remove. |
| resetOptions | | public void resetOptions()(Code) | | This method removes all options from the component.
|
| selectAll | | public void selectAll()(Code) | | Selects all items in the list
|
| setAccessKey | | public void setAccessKey(String string)(Code) | |
Parameters:
string - sets the access key html attribute |
| setAll | | public void setAll(boolean selected)(Code) | | Selects or deselects all items in the list
Parameters:
selected - DOCUMENT ME! |
| setFontEndTag | | public void setFontEndTag(String value)(Code) | | This method sets the end font tag for the component.
Parameters:
value - DOCUMENT ME! |
| setFontStartTag | | public void setFontStartTag(String value)(Code) | | This method sets the start font tag for the component.
Parameters:
value - DOCUMENT ME! |
| setMulti | | public void setMulti(boolean multi)(Code) | | This method sets the whether or not the user can select multiple rows from the component.
Parameters:
multi - DOCUMENT ME! |
| setOnChange | | public void setOnChange(String value)(Code) | | This method sets the javascript to be executed when the value of the text in the component changes.
Parameters:
value - DOCUMENT ME! |
| setOnClick | | public void setOnClick(String value)(Code) | | This method sets the javascript to be executed when the component is clicked on.
Parameters:
value - DOCUMENT ME! |
| setOnFocus | | public void setOnFocus(String value)(Code) | | This method sets the javascript to be executed when the component gains focus.
Parameters:
value - DOCUMENT ME! |
| setOnLoseFocus | | public void setOnLoseFocus(String value)(Code) | | This method sets the javascript to be executed when the component loses focus.
Parameters:
value - DOCUMENT ME! |
| setOptionSelected | | public void setOptionSelected(int index, boolean selected)(Code) | | Use this method set whether an option is selected.
Parameters:
index - DOCUMENT ME!
Parameters:
selected - DOCUMENT ME! |
| setOptionValue | | public void setOptionValue(int index, String value)(Code) | | Use this method to set the value of the option at index.
Parameters:
index - DOCUMENT ME!
Parameters:
value - DOCUMENT ME! |
| setSize | | public void setSize(int size)(Code) | | This method sets the display size for the component in characters.
Parameters:
size - DOCUMENT ME! |
| setStyle | | public void setStyle(String style)(Code) | | This method sets the property style (allows for the inlining of style attributes like color:#666666;) for the component.
Parameters:
style - - The style text to use. |
| setTabIndex | | public void setTabIndex(int val)(Code) | |
Parameters:
val - sets the tab index html attribute. You can also pass TAB_INDEX_DEFAULT to use the default tab index for the component or TAB_INDEX_NONE to keep this component from being tabbed to |
| setTheme | | public void setTheme(String theme)(Code) | | This method sets the property theme for the component.
Parameters:
theme - The theme to use. |
| sort | | public void sort()(Code) | | Claudio Pi (4-01-2003) This method sorts the dropdown list based on its options values in the default order direction.
|
| sort | | public void sort(int dir)(Code) | | Claudio Pi (4-01-2003) This method sorts the dropdown list based on its options values in the given order direction.
Parameters:
dir - direction in which the options will be sorted (0=Ascending or 1=Descending order) |
| Methods inherited from com.salmonllc.html.HtmlFormComponent | protected void addEvent(ValueChangedEvent e)(Code)(Java Doc)
public void addValueChangedListener(ValueChangedListener l)(Code)(Java Doc)
protected void convertValue()(Code)(Java Doc)
public boolean executeEvent(int eventType) throws Exception(Code)(Java Doc)
protected int findEvent(int rowNo)(Code)(Java Doc)
protected void generateAutoTabJavaScript(PrintWriter pw)(Code)(Java Doc)
abstract public void generateHTML(java.io.PrintWriter p, int row) throws Exception(Code)(Java Doc)
public DataStoreBuffer getBoundDataStore()(Code)(Java Doc)
public int getColumnNumber()(Code)(Java Doc)
protected String getDataStoreValue(int rowNo)(Code)(Java Doc)
public String getDisabledFontEndTag()(Code)(Java Doc)
public String getDisabledFontStartTag()(Code)(Java Doc)
public String getDisplayFormat()(Code)(Java Doc)
public String getDisplayFormatLocaleKey()(Code)(Java Doc)
public boolean getEnabled()(Code)(Java Doc)
protected ValueChangedEvent getEventAt(int index)(Code)(Java Doc)
protected int getEventCount()(Code)(Java Doc)
public String getJavaScriptName()(Code)(Java Doc)
public String getTheme()(Code)(Java Doc)
public String getValue()(Code)(Java Doc)
public String getValue(int rowNo)(Code)(Java Doc)
protected String getValue(int rowNo, boolean remove)(Code)(Java Doc)
public boolean isEnabled()(Code)(Java Doc)
public boolean isValid()(Code)(Java Doc)
protected void processLocaleInfo()(Code)(Java Doc)
protected void removeEvent(int index)(Code)(Java Doc)
public void removeValueChangedListener(ValueChangedListener l)(Code)(Java Doc)
public void reset()(Code)(Java Doc)
public void setColumn(DataStoreBuffer ds, int columnNo)(Code)(Java Doc)
public void setColumn(DataStoreBuffer ds, String columnName)(Code)(Java Doc)
public void setDisabledFontEndTag(String tag)(Code)(Java Doc)
public void setDisabledFontStartTag(String tag)(Code)(Java Doc)
public void setDisplayFormat(String format)(Code)(Java Doc)
public void setDisplayFormatLocaleKey(String formatLocaleKey)(Code)(Java Doc)
public void setEnabled(boolean enabled)(Code)(Java Doc)
public void setEnabled(boolean enabled, boolean useDisableAttribute)(Code)(Java Doc)
public void setFocus()(Code)(Java Doc)
public void setFocus(boolean select)(Code)(Java Doc)
public void setFocus(int row, boolean select)(Code)(Java Doc)
public void setFocus(int row)(Code)(Java Doc)
public void setForceCase(int mode)(Code)(Java Doc)
protected boolean setTempValue(String value, int rowNo, int eventNo)(Code)(Java Doc)
public void setTheme(String theme)(Code)(Java Doc)
public void setValue(String value)(Code)(Java Doc)
public void setValue(String value, int rowNo)(Code)(Java Doc)
public String toString()(Code)(Java Doc)
public void updateLocale()(Code)(Java Doc)
protected boolean valuesEqual(Object newValue, Object oldValue)(Code)(Java Doc)
protected void writeFocusScript(java.io.PrintWriter p, int row)(Code)(Java Doc)
|
|
|