com.sssw.shr.page
Class AgpList
java.lang.Object
|
+--com.sssw.shr.page.AgpTag
|
+--com.sssw.shr.page.AgpControlBase
|
+--com.sssw.shr.page.AgpListBase
|
+--com.sssw.shr.page.AgpList
- All Implemented Interfaces:
- AgiJavaScriptEnhanced, AgiPageControl, AgiRowSetManager, Cloneable, Externalizable, Serializable
- public class AgpList
- extends AgpListBase
HTML List control.
The List control can display multiple values to users.
The users can browse the list of values and select a value from the list.
Note that the width is determined by the content, which
might not be known at design time.
- Properties:
- Automatic Query, Choices, Data Column, Display Value, Distinct, Enable HTML Generation, Limit Rows, Load Choices, Maximum Rows, Multiple Select, Name, Order By, Put Values In OPTION Tag, Rows To Display, Storage Value, Submit On Change, Table Name, Values, Where Clause
- Events:
- validationFailed, validationTest, valueChanged
- See Also:
- Serialized Form
Method Summary |
void |
deselectAll()
Deselects all items in the list. |
int |
getVisibleRowCount()
Returns the Rows to Display property for the control. |
boolean |
isMultipleMode()
Returns whether the control supports multiple selection. |
void |
setMultipleMode(boolean multi_select)
Sets the Multiple Select property of the control. |
void |
setVisibleRowCount(int size)
Sets the Rows to Display property for the control. |
Methods inherited from class com.sssw.shr.page.AgpListBase |
add,
add,
deselect,
getItem,
getItemCount,
getItems,
getItemValue,
getItemValues,
getSelectedIndex,
getSubmitOnChange,
getValue,
getValueInOptionTag,
insert,
insert,
isSelected,
loadFromRowCursor,
remove,
removeAll,
replaceItem,
replaceItem,
select,
setSubmitOnChange,
setValue,
setValueInOptionTag |
Methods inherited from class com.sssw.shr.page.AgpTag |
getBoolProperty,
getEnableHTMLGeneration,
getIntArrayProperty,
getIntProperty,
getIntPropertyUnit,
getProperty,
getStringArrayProperty,
invalidateHTML,
removeProperty,
setEnableHTMLGeneration,
setIntProperty,
setProperty |
Methods inherited from class java.lang.Object |
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait |
AgpList
public AgpList()
isMultipleMode
public boolean isMultipleMode()
- Returns whether the control supports multiple selection.
- Example:
-
- See Also:
- MultipleSelect property,
AgpList.setMultipleMode(boolean multi_select)
setMultipleMode
public void setMultipleMode(boolean multi_select)
- Sets the Multiple Select property of the control.
It specifies whether the control supports the selection of more than one row at a time.
- Parameters:
multi_select
- true
if the control should support multiple selection
of rows, or false
if the control should only support single selection.- Example:
-
- See Also:
- MultipleSelect property,
AgpList.isMultipleMode()
getVisibleRowCount
public int getVisibleRowCount()
- Returns the Rows to Display property for the control.
It specifies the number of rows to display at one time.
- Example:
-
- See Also:
- Rows to Display property,
AgpList.setVisibleRowCount(int size)
setVisibleRowCount
public void setVisibleRowCount(int size)
- Sets the Rows to Display property for the control.
It specifies the number of rows to display at one time.
The minimum number is two.
- Parameters:
size
- the number of rows to display at one time.- Example:
-
- See Also:
- Rows to Display property,
AgpList.getVisibleRowCount()
deselectAll
public void deselectAll()
- Deselects all items in the list.
- Example:
-