| java.lang.Object
 com.salmonllc.html.HtmlComponent
com.salmonllc.html.HtmlContainer
com.salmonllc.forms.BaseForm
com.salmonllc.forms.BaseListForm
All known Subclasses: com.salmonllc.forms.ListForm, com.salmonllc.forms.ListInlineEditingForm,
| BaseListForm | | public class BaseListForm extends BaseForm implements SubmitListener(Code) | | Implements Search/List form.
At the top will be a display box with a table for search criteria and a "Search" button.
Following will be another display box with a datatable to display the results from the
search. This box contains a "Add" button which requests the detail page (name supplied)
with the parameters "mode=add", and "=", the second repeated for
as many primary keys as there are.
The client of this class will add data-store columns, specifying whether they go in
the search box, list box, or both.
The form is implemented as a container to go within an instance of (a subclass of)
HtmlPage. Specify as many data store columns as you want using the addColumn* methods
and indicate which goes in the search box and which goes in the list box.
To hook key activities such as the "Add" button, implement the ListFormListener interface
and call addListener.
Example:
ListForm form = new ListForm(this, "UserDetailPage");
add(form);
form.addColumn(_table, "user_id", "ID#", DataStoreBuffer.DATATYPE_INT, form.PRIMARY_KEY,
"UserDetailPage?mode=update");
// add other columns ...
|
| Method Summary | |
| public void | addBucket(String name, String caption, int type, int flags)
Creates a datastore bucket and corresponding display components for the search and list
boxes.
Parameters:
name - Name of bucket
Parameters:
caption - Caption for search box and/or list box, or null
Parameters:
type - Type of datastore column, using DataStore.DATATYPE_* values
Parameters:
flags - Bitwise-OR combination of PRIMARY_KEY, etc. | | public void | addBucket(String name, String caption, int type, int flags, String href, String format)
Creates a datastore bucket and corresponding display components for the search and list
boxes.
Parameters:
name - Name of bucket
Parameters:
caption - Caption for search box and/or list box, or null
Parameters:
type - Type of datastore column, using DataStore.DATATYPE_* values
Parameters:
flags - Bitwise-OR combination of PRIMARY_KEY, etc. | | public void | addBucket(String name, String caption, int type, int flags, String href, String format, HtmlTableCellProperties propCaption, HtmlTableCellProperties propSearch, HtmlTableCellProperties propList)
Creates a datastore bucket and corresponding display components for the search and list
boxes.
Parameters:
name - Name of bucket
Parameters:
caption - Caption for search box and/or list box, or null
Parameters:
type - Type of datastore column, using DataStore.DATATYPE_* values
Parameters:
flags - Bitwise-OR combination of PRIMARY_KEY, etc. | | public void | addColumn(String table, String column, String caption, int type, int flags)
Creates a datastore column and corresponding display components for the search and list
boxes.
Parameters:
table - Name of table for datastore
Parameters:
column - Name of column for datastore
Parameters:
caption - Caption for search box and/or list box, or null
Parameters:
type - Type of datastore column, using DataStore.DATATYPE_* values
Parameters:
flags - Bitwise-OR combination of PRIMARY_KEY, etc. | | public void | addColumn(String table, String column, String caption, int type, int flags, String href)
Creates a datastore column and corresponding display components for the search and list
boxes.
Parameters:
table - Name of table for datastore
Parameters:
column - Name of column for datastore
Parameters:
caption - Caption for search box and/or list box, or null
Parameters:
type - Type of datastore column, using DataStore.DATATYPE_* values
Parameters:
flags - Bitwise-OR combination of PRIMARY_KEY, etc. | | public void | addColumn(String table, String column, String caption, int type, int flags, String href, String format)
Creates a datastore column and corresponding display components for the search and list
boxes.
Parameters:
table - Name of table for datastore
Parameters:
column - Name of column for datastore
Parameters:
caption - Caption for search box and/or list box, or null
Parameters:
type - Type of datastore column, using DataStore.DATATYPE_* values
Parameters:
flags - Bitwise-OR combination of PRIMARY_KEY, etc. | | public void | addColumn(String table, String column, String caption, int type, int flags, String href, String format, HtmlTableCellProperties propCaption, HtmlTableCellProperties propSearch, HtmlTableCellProperties propList)
Creates a datastore column and corresponding display components for the search and list
boxes.
Parameters:
table - Name of table for datastore. | | public void | addComposite(HtmlComposite composite, String caption, int flags)
Adds a column to the data store and list box, search box, or both.
The column is of type integer and the display is a radio button group.
Parameters:
table - Name of table for datastore
Parameters:
column - Name of column for datastore
Parameters:
caption - Caption for search box and/or list box, or null
Parameters:
flags - Bitwise-OR combination of PRIMARY_KEY, etc. | | public void | addDateRange(String table, String column, String caption, int flags, String format)
Adds a column to the data store and list box, search box, or both.
The column is of type date-time. | | public HtmlComponent | addIntegerDropDown(String table, String column, String caption, int flags, int values, String displayValues)
Adds a column to the data store and list box, search box, or both.
The column is of type integer and the display is a drop-down list.
Parameters:
table - Name of table for datastore
Parameters:
column - Name of column for datastore
Parameters:
caption - Caption for search box and/or list box, or null
Parameters:
flags - Bitwise-OR combination of PRIMARY_KEY, etc. | | public HtmlComponent | addIntegerDropDown(String table, String column, String caption, int flags, int values, String displayValues, boolean isMandatory)
Adds a column to the data store and list box, search box, or both.
The column is of type integer and the display is a drop-down list.
Parameters:
table - Name of table for datastore
Parameters:
column - Name of column for datastore
Parameters:
caption - Caption for search box and/or list box, or null
Parameters:
flags - Bitwise-OR combination of PRIMARY_KEY, etc. | | public HtmlComponent | addIntegerRadioButtonGroup(String table, String column, String caption, int flags, int values, String displayValues)
Adds a column to the data store and list box, search box, or both.
The column is of type integer and the display is a radio button group.
Parameters:
table - Name of table for datastore
Parameters:
column - Name of column for datastore
Parameters:
caption - Caption for search box and/or list box, or null
Parameters:
flags - Bitwise-OR combination of PRIMARY_KEY, etc. | | public HtmlComponent | addIntegerRadioButtonGroup(String table, String column, String caption, int flags, int values, String displayValues, String defaultVal)
Adds a column to the data store and list box, search box, or both.
The column is of type integer and the display is a radio button group.
Parameters:
table - Name of table for datastore
Parameters:
column - Name of column for datastore
Parameters:
caption - Caption for search box and/or list box, or null
Parameters:
flags - Bitwise-OR combination of PRIMARY_KEY, etc. | | public HtmlComponent | addIntegerRadioButtonGroup(String table, String column, String caption, int flags, int values, String displayValues, String defaultVal, HtmlTableCellProperties propCaption, HtmlTableCellProperties propSearch)
Adds a column to the data store and list box, search box, or both.
The column is of type integer and the display is a radio button group.
Parameters:
table - Name of table for datastore
Parameters:
column - Name of column for datastore
Parameters:
caption - Caption for search box and/or list box, or null
Parameters:
flags - Bitwise-OR combination of PRIMARY_KEY, etc. | | public void | addListBoxHeadingComponent(HtmlComponent c)
Adds a given component to heading of list box. | | public void | addListDisplay(String fullColName, String caption, HtmlComponent component)
Adds a component to the List display. | | public void | addListDisplay(String fullColName, String caption, HtmlComponent component, HtmlTableCellProperties prop)
Adds a component to the List display. | | public void | addListener(ListFormListener listener)
Adds a ListFormListener. | | public void | addParameterKey(String pageParam)
Adds to a list of Parameters to pass on during an add operation. | | public HtmlComponent | addPreInitDropDown(String table, String column, String caption, int flags, String initTable, String initName, String descName)
Adds a column to the data store and list box, search box, or both.
The column is of type integer and the display is a drop-down list which is
preinitialized from a second table structured in a particular way.
Parameters:
table - Name of table for datastore
Parameters:
column - Name of column for datastore
Parameters:
caption - Caption for search box and/or list box, or null
Parameters:
flags - Bitwise-OR combination of PRIMARY_KEY, etc. | | public HtmlComponent | addPreInitRadioButtonGroup(String table, String column, String caption, int flags, String initName, String descName)
Adds a column to the data store and list box, search box, or both.
The column is of type integer and the display is a drop-down list which is
preinitialized from a second table structured in a particular way.
Parameters:
table - Name of table for datastore
Parameters:
column - Name of column for datastore
Parameters:
caption - Caption for search box and/or list box, or null
Parameters:
flags - Bitwise-OR combination of PRIMARY_KEY, etc. | | public HtmlComponent | addPreInitRadioButtonGroup(String table, String column, String caption, int flags, String initTable, String initName, String descName)
Adds a column to the data store and list box, search box, or both.
The column is of type integer and the display is a drop-down list which is
preinitialized from a second table structured in a particular way.
Parameters:
table - Name of table for datastore
Parameters:
column - Name of column for datastore
Parameters:
caption - Caption for search box and/or list box, or null
Parameters:
flags - Bitwise-OR combination of PRIMARY_KEY, etc. | | public HtmlComponent | addPreInitStringDropDown(String table, String column, String caption, int flags, String initTable, String initName, String descName)
Adds a column to the data store and list box, search box, or both.
The column is of type integer and the display is a drop-down list which is
preinitialized from a second table structured in a particular way.
Parameters:
table - Name of table for datastore
Parameters:
column - Name of column for datastore
Parameters:
caption - Caption for search box and/or list box, or null
Parameters:
flags - Bitwise-OR combination of PRIMARY_KEY, etc. | | public HtmlComponent | addPreInitStringRadioButtonGroup(String table, String column, String caption, int flags, String initTable, String initName, String descName)
Adds a column to the data store and list box, search box, or both.
The column is of type integer and the display is a drop-down list which is
preinitialized from a second table structured in a particular way.
Parameters:
table - Name of table for datastore
Parameters:
column - Name of column for datastore
Parameters:
caption - Caption for search box and/or list box, or null
Parameters:
flags - Bitwise-OR combination of PRIMARY_KEY, etc. | | public void | addSearchBoxHeadingComponent(HtmlComponent c)
Adds a given component to heading of search box. | | public HtmlFormComponent | addSearchComponent(String name, String caption, int type, int flags)
Creates an entry component for the search box and returns it. | | public HtmlComponent | addSearchDisplay(String name, String caption, HtmlComponent component, int flags)
Adds a component to the Search display box. | | public HtmlComponent | addSearchDisplay(String name, String caption, HtmlComponent component, int flags, HtmlTableCellProperties propCaption, HtmlTableCellProperties propSearch)
Adds a component to the Search display box. | | public HtmlComponent | addStringDropDown(String table, String column, String caption, int flags, String values, String displayValues)
Adds a column to the data store and list box, search box, or both.
The column is of type integer and the display is a drop-down list.
Parameters:
table - Name of table for datastore
Parameters:
column - Name of column for datastore
Parameters:
caption - Caption for search box and/or list box, or null
Parameters:
flags - Bitwise-OR combination of PRIMARY_KEY, etc. | | public HtmlComponent | addStringDropDown(String table, String column, String caption, int flags, String values, String displayValues, boolean isMandatory)
Adds a column to the data store and list box, search box, or both.
The column is of type integer and the display is a drop-down list.
Parameters:
table - Name of table for datastore
Parameters:
column - Name of column for datastore
Parameters:
caption - Caption for search box and/or list box, or null
Parameters:
flags - Bitwise-OR combination of PRIMARY_KEY, etc. | | public HtmlComponent | addStringRadioButtonGroup(String table, String column, String caption, int flags, String values, String displayValues)
Adds a column to the data store and list box, search box, or both.
The column is of type integer and the display is a radio button group.
Parameters:
table - Name of table for datastore
Parameters:
column - Name of column for datastore
Parameters:
caption - Caption for search box and/or list box, or null
Parameters:
flags - Bitwise-OR combination of PRIMARY_KEY, etc. | | public HtmlComponent | addStringRadioButtonGroup(String table, String column, String caption, int flags, String values, String displayValues, String defaultVal)
Adds a column to the data store and list box, search box, or both.
The column is of type integer and the display is a radio button group.
Parameters:
table - Name of table for datastore
Parameters:
column - Name of column for datastore
Parameters:
caption - Caption for search box and/or list box, or null
Parameters:
flags - Bitwise-OR combination of PRIMARY_KEY, etc. | | public HtmlComponent | addStringRadioButtonGroup(String table, String column, String caption, int flags, String values, String displayValues, String defaultVal, HtmlTableCellProperties propCaption, HtmlTableCellProperties propSearch)
Adds a column to the data store and list box, search box, or both.
The column is of type integer and the display is a radio button group.
Parameters:
table - Name of table for datastore
Parameters:
column - Name of column for datastore
Parameters:
caption - Caption for search box and/or list box, or null
Parameters:
flags - Bitwise-OR combination of PRIMARY_KEY, etc. | | public void | doRetrieve()
Retrieve from database table into datastore according to search criteria. | | protected int | findOrAdd(String name)
Gets the object container matching the name. | | public String | getAdvancedSearchCaption()
Get advanced caption of the Advanced Search Link. | | public Enumeration | getBaseListFormComponents()
Returns a list of all search components. | | public String | getBasicSearchCaption()
Get the Basic caption of the Advanced Search Link. | | protected BaseListFormComponent | getContainer(String name)
Gets the object container matching the name, else null. | | public DataStore | getDataStore()
Return the internal DataStore object. | | public HtmlDisplayBox | getListBox()
Returns display box component for list box. | | public HtmlComponent | getListComponent(String name)
Returns component in list box associated with given name, or null. | | public HtmlComponent | getListLinkComponent(String name)
Returns component in list box associated with given name, or null. | | public HtmlDataTable | getListTable()
Returns the data-table instance used for list box. | | public HtmlDisplayBox | getSearchBox()
Returns display box component for search box. | | public HtmlComponent | getSearchComponent(String name)
Returns component in search box associated with given name, or null. | | public Enumeration | getSearchComponents()
Returns a list of all search components. | | public String | getSearchCriteria()
| | protected HtmlFormComponent | makeComponent(String name, int type)
Does the work of creating a component according to type. | | protected HtmlRadioButtonGroup | newRadioButtonGroup(String name, int values, String displayValues, String defaultVal)
Creates an integer-type radio-button group list like HtmlComponenFactory but tailored
to needs of the forms subclasses. | | protected HtmlRadioButtonGroup | newRadioButtonGroup(String name, String values, String displayValues, String defaultVal)
Creates an integer-type radio-button group list like HtmlComponenFactory but tailored
to needs of the forms subclasses. | | public void | pageRequested(PageEvent p)
This event will get fired each time a page is requested by the browser. | | protected Date | parseDate(String sValue)
This method was created to parse a date string
and return a valid java.util.Date object . | | protected void | processSearchComponent(int i, CriteriaString cr)
Process a search component. | | protected void | processSearchCompositeComponent(HtmlComposite composite, CriteriaString cr)
Process a search component. | | public void | removeParameterKey(String pageParam)
| | public void | resetParameters()
Resets keys and values to empty. | | public void | setAddImage(HtmlSubmitImage img)
| | public void | setAddImage(String imageUrl)
| | public void | setAdvancedSearchCaption(String caption)
Set caption of the Advanced Search Link. | | public void | setBasicSearchCaption(String caption)
Set basic caption of the Advanced Search Link. | | public void | setLinkFont(String font)
Sets the font used for HtmlLink components created by the form. | | public void | setListBoxCaption(String caption)
Set heading caption of list box. | | public void | setParameterValue(String pageParam, String value, boolean extend)
Adds to a list of Parameters to pass on during an add operation.
Parameters:
pageParam - String Parameter to associate key with
Parameters:
value - String Value of key
Parameters:
extend - boolean should we add another value to this key(ex. | | public void | setSearchBoxCaption(String caption)
Set heading caption of search box. | | public void | setSearchImage(HtmlSubmitImage img)
| | public void | setSearchImage(String imageUrl)
| | public void | showAddButton(boolean visible)
This method toggles the visiblity of the default add button. | | public void | showSearchButton(boolean visible)
This method toggles the visiblity of the default search button. | | public boolean | submitPerformed(SubmitEvent e)
Inherited abstract method. |
| ADVANCED_SEARCH | | final public static int ADVANCED_SEARCH(Code) | | addColumn flags parameter: Use in advanced search.Default to top of search box
|
| EXACT_MATCH | | final public static int EXACT_MATCH(Code) | | addColumn flags parameter: Use exact match for string value, not LIKE.
|
| IGNORE_CASE | | final public static int IGNORE_CASE(Code) | | addColumn flags parameter: Use exact match for string value, not LIKE.
|
| INIT_ADVANCED_SEARCH_LINK | | final public static int INIT_ADVANCED_SEARCH_LINK(Code) | | constructor flags parameter: Create the Advanced Search Link.
|
| INIT_ADVANCED_SEARCH_ON_SIDE | | final public static int INIT_ADVANCED_SEARCH_ON_SIDE(Code) | | addColumn flags parameter: Location of advanced search link
|
| INIT_NO_ADD_BUTTON | | final public static int INIT_NO_ADD_BUTTON(Code) | | constructor flags parameter: Do not create the default Add button.
|
| INIT_NO_SEARCH_BUTTON | | final public static int INIT_NO_SEARCH_BUTTON(Code) | | constructor flags parameter: Do not create the default Search button.
|
| LEADING_WILDCARD | | final public static int LEADING_WILDCARD(Code) | | addColumn flags parameter: Places wildcard at the beginning
|
| LIST_ONLY | | final public static int LIST_ONLY(Code) | | addColumn flags parameter: Only in list box.
|
| NO_SEARCH | | final public static int NO_SEARCH(Code) | | addColumn flags parameter: Do not process in retrieve (search).
|
| PRECEDENCE | | final public static int PRECEDENCE(Code) | | addColumn flags parameter: Takes precedence in search. Ignore other search criteria if this one is not empty.
|
| PRIMARY_KEY | | final public static int PRIMARY_KEY(Code) | | addColumn flags parameter: Primary key.
|
| SAME_ROW | | final public static int SAME_ROW(Code) | | addColumn flags parameter: Do not start a new row in search box.
|
| SEARCH_ONLY | | final public static int SEARCH_ONLY(Code) | | addColumn flags parameter: Only in search box.
|
| _colSearch | | protected int _colSearch(Code) | | |
| _rowList | | protected int _rowList(Code) | | |
| _rowSearch | | protected int _rowSearch(Code) | | |
| BaseListForm | | public BaseListForm(HtmlPage page)(Code) | | Implements standard Search/List form.
Default data store is created. Standard add button is included.
Parameters:
page - Page containing this form as a component.
Parameters:
detailPageName - Name of associated detail page. |
| BaseListForm | | public BaseListForm(HtmlPage page, DataStore ds)(Code) | | Implements standard Search/List form.
Standard add button is included.
Parameters:
page - HtmlPage Page containing this form as a component.
Parameters:
detailPageName - String Name of corresponding detail page to use as link destination.
Parameters:
ds - DataStore Data store object to use; if null then create one. |
| BaseListForm | | public BaseListForm(HtmlPage page, DataStore ds, int flags)(Code) | | Implements standard Search/List form.
Parameters:
page - Page containing this form as a component.
Parameters:
detailPageName - Name of corresponding detail page to use as link destination.
Parameters:
ds - Data store object to use; if null then create one.
Parameters:
flags - Bitwise-OR combination of INIT_NO_SEARCH_BUTTON, etc. |
| addBucket | | public void addBucket(String name, String caption, int type, int flags) throws Exception(Code) | | Creates a datastore bucket and corresponding display components for the search and list
boxes.
Parameters:
name - Name of bucket
Parameters:
caption - Caption for search box and/or list box, or null
Parameters:
type - Type of datastore column, using DataStore.DATATYPE_* values
Parameters:
flags - Bitwise-OR combination of PRIMARY_KEY, etc. 0 = default. |
| addBucket | | public void addBucket(String name, String caption, int type, int flags, String href, String format) throws Exception(Code) | | Creates a datastore bucket and corresponding display components for the search and list
boxes.
Parameters:
name - Name of bucket
Parameters:
caption - Caption for search box and/or list box, or null
Parameters:
type - Type of datastore column, using DataStore.DATATYPE_* values
Parameters:
flags - Bitwise-OR combination of PRIMARY_KEY, etc. 0 = default.
Parameters:
href - HREF to use in hotlink from this column in list box, else null.
Parameters:
format - Format used to display column in listbox (as in DataStore), else null. |
| addBucket | | public void addBucket(String name, String caption, int type, int flags, String href, String format, HtmlTableCellProperties propCaption, HtmlTableCellProperties propSearch, HtmlTableCellProperties propList) throws Exception(Code) | | Creates a datastore bucket and corresponding display components for the search and list
boxes.
Parameters:
name - Name of bucket
Parameters:
caption - Caption for search box and/or list box, or null
Parameters:
type - Type of datastore column, using DataStore.DATATYPE_* values
Parameters:
flags - Bitwise-OR combination of PRIMARY_KEY, etc. 0 = default.
Parameters:
href - HREF to use in hotlink from this column in list box, else null.
Parameters:
format - Format used to display column in listbox (as in DataStore), else null.
Parameters:
propCaption - HtmlTableCellProperties
Parameters:
propSearch - HtmlTableCellProperties
Parameters:
propList - HtmlTableCellProperties |
| addColumn | | public void addColumn(String table, String column, String caption, int type, int flags) throws Exception(Code) | | Creates a datastore column and corresponding display components for the search and list
boxes.
Parameters:
table - Name of table for datastore
Parameters:
column - Name of column for datastore
Parameters:
caption - Caption for search box and/or list box, or null
Parameters:
type - Type of datastore column, using DataStore.DATATYPE_* values
Parameters:
flags - Bitwise-OR combination of PRIMARY_KEY, etc. 0 = default. |
| addColumn | | public void addColumn(String table, String column, String caption, int type, int flags, String href) throws Exception(Code) | | Creates a datastore column and corresponding display components for the search and list
boxes.
Parameters:
table - Name of table for datastore
Parameters:
column - Name of column for datastore
Parameters:
caption - Caption for search box and/or list box, or null
Parameters:
type - Type of datastore column, using DataStore.DATATYPE_* values
Parameters:
flags - Bitwise-OR combination of PRIMARY_KEY, etc. 0 = default.
Parameters:
href - HREF to use in hotlink from this column in list box, else null. |
| addColumn | | public void addColumn(String table, String column, String caption, int type, int flags, String href, String format) throws Exception(Code) | | Creates a datastore column and corresponding display components for the search and list
boxes.
Parameters:
table - Name of table for datastore
Parameters:
column - Name of column for datastore
Parameters:
caption - Caption for search box and/or list box, or null
Parameters:
type - Type of datastore column, using DataStore.DATATYPE_* values
Parameters:
flags - Bitwise-OR combination of PRIMARY_KEY, etc. 0 = default.
Parameters:
href - HREF to use in hotlink from this column in list box, else null.
Parameters:
format - Format used to display column in listbox (as in DataStore), else null. |
| addColumn | | public void addColumn(String table, String column, String caption, int type, int flags, String href, String format, HtmlTableCellProperties propCaption, HtmlTableCellProperties propSearch, HtmlTableCellProperties propList) throws Exception(Code) | | Creates a datastore column and corresponding display components for the search and list
boxes.
Parameters:
table - Name of table for datastore. If table == null then table will be forced to "NULL_TABLE"
Parameters:
column - Name of column for datastore
Parameters:
caption - Caption for search box and/or list box, or null
Parameters:
type - Type of datastore column, using DataStore.DATATYPE_* values
Parameters:
flags - Bitwise-OR combination of PRIMARY_KEY, etc. 0 = default.
Parameters:
href - HREF to use in hotlink from this column in list box, else null.
Parameters:
format - Format used to display column in listbox (as in DataStore), else null.
Parameters:
propCaption - HtmlTableCellProperties
Parameters:
propSearch - HtmlTableCellProperties
Parameters:
propList - HtmlTableCellProperties |
| addComposite | | public void addComposite(HtmlComposite composite, String caption, int flags) throws Exception(Code) | | Adds a column to the data store and list box, search box, or both.
The column is of type integer and the display is a radio button group.
Parameters:
table - Name of table for datastore
Parameters:
column - Name of column for datastore
Parameters:
caption - Caption for search box and/or list box, or null
Parameters:
flags - Bitwise-OR combination of PRIMARY_KEY, etc. 0 = default. |
| addDateRange | | public void addDateRange(String table, String column, String caption, int flags, String format) throws Exception(Code) | | Adds a column to the data store and list box, search box, or both.
The column is of type date-time. The search display is a pair of
entry fields corresponding to a range of dates with captions "from"
and "to". If the "to" date is empty then the search criteria is
>= the "from" date; if the "from" date is empty then the criteria is
<= the "to" date.
Parameters:
table - Name of table for datastore
Parameters:
column - Name of column for datastore
Parameters:
caption - Caption for search box and/or list box, or null
Parameters:
flags - Bitwise-OR combination of PRIMARY_KEY, etc. 0 = default.
Parameters:
format - Format used to display column in listbox (as in DataStore), else null. |
| addIntegerDropDown | | public HtmlComponent addIntegerDropDown(String table, String column, String caption, int flags, int values, String displayValues) throws Exception(Code) | | Adds a column to the data store and list box, search box, or both.
The column is of type integer and the display is a drop-down list.
Parameters:
table - Name of table for datastore
Parameters:
column - Name of column for datastore
Parameters:
caption - Caption for search box and/or list box, or null
Parameters:
flags - Bitwise-OR combination of PRIMARY_KEY, etc. 0 = default. int[] values A list of values for the column. String[] dispValues A list of corresponding display values for each of the values for the column. |
| addIntegerDropDown | | public HtmlComponent addIntegerDropDown(String table, String column, String caption, int flags, int values, String displayValues, boolean isMandatory) throws Exception(Code) | | Adds a column to the data store and list box, search box, or both.
The column is of type integer and the display is a drop-down list.
Parameters:
table - Name of table for datastore
Parameters:
column - Name of column for datastore
Parameters:
caption - Caption for search box and/or list box, or null
Parameters:
flags - Bitwise-OR combination of PRIMARY_KEY, etc. 0 = default. int[] values A list of values for the column. String[] dispValues A list of corresponding display values for each of the values for the column. |
| addIntegerRadioButtonGroup | | public HtmlComponent addIntegerRadioButtonGroup(String table, String column, String caption, int flags, int values, String displayValues) throws Exception(Code) | | Adds a column to the data store and list box, search box, or both.
The column is of type integer and the display is a radio button group.
Parameters:
table - Name of table for datastore
Parameters:
column - Name of column for datastore
Parameters:
caption - Caption for search box and/or list box, or null
Parameters:
flags - Bitwise-OR combination of PRIMARY_KEY, etc. 0 = default. int[] values A list of values for the column. String[] dispValues A list of corresponding display values for each of the values for the column. |
| addIntegerRadioButtonGroup | | public HtmlComponent addIntegerRadioButtonGroup(String table, String column, String caption, int flags, int values, String displayValues, String defaultVal) throws Exception(Code) | | Adds a column to the data store and list box, search box, or both.
The column is of type integer and the display is a radio button group.
Parameters:
table - Name of table for datastore
Parameters:
column - Name of column for datastore
Parameters:
caption - Caption for search box and/or list box, or null
Parameters:
flags - Bitwise-OR combination of PRIMARY_KEY, etc. 0 = default. int[] values A list of values for the column. String[] dispValues A list of corresponding display values for each of the values for the column.
Parameters:
defaultVal - java.lang.String The defalt Radio Button you want selected |
| addIntegerRadioButtonGroup | | public HtmlComponent addIntegerRadioButtonGroup(String table, String column, String caption, int flags, int values, String displayValues, String defaultVal, HtmlTableCellProperties propCaption, HtmlTableCellProperties propSearch) throws Exception(Code) | | Adds a column to the data store and list box, search box, or both.
The column is of type integer and the display is a radio button group.
Parameters:
table - Name of table for datastore
Parameters:
column - Name of column for datastore
Parameters:
caption - Caption for search box and/or list box, or null
Parameters:
flags - Bitwise-OR combination of PRIMARY_KEY, etc. 0 = default. int[] values A list of values for the column. String[] dispValues A list of corresponding display values for each of the values for the column.
Parameters:
defaultVal - java.lang.String The defalt Radio Button you want selected
Parameters:
propCaption - HtmlTableCellProperties
Parameters:
propSearch - HtmlTableCellProperties |
| addListBoxHeadingComponent | | public void addListBoxHeadingComponent(HtmlComponent c)(Code) | | Adds a given component to heading of list box.
|
| addListDisplay | | public void addListDisplay(String fullColName, String caption, HtmlComponent component) throws Exception(Code) | | Adds a component to the List display.
Parameters:
fullColName - Datastore column name in form table.column
Parameters:
caption - Listbox caption, or null
Parameters:
component - HtmlComponent The component to add |
| addListDisplay | | public void addListDisplay(String fullColName, String caption, HtmlComponent component, HtmlTableCellProperties prop) throws Exception(Code) | | Adds a component to the List display.
Parameters:
fullColName - Datastore column name in form table.column
Parameters:
caption - Listbox caption, or null
Parameters:
component - HtmlComponent The component to add
Parameters:
properties - HtmlTableCellProperties Table cell properties |
| addListener | | public void addListener(ListFormListener listener)(Code) | | Adds a ListFormListener.
Parameters:
listener - ListFormListener |
| addParameterKey | | public void addParameterKey(String pageParam)(Code) | | Adds to a list of Parameters to pass on during an add operation.
Parameters:
pageParam - Parameter to pass on during an add operation |
| addPreInitDropDown | | public HtmlComponent addPreInitDropDown(String table, String column, String caption, int flags, String initTable, String initName, String descName) throws Exception(Code) | | Adds a column to the data store and list box, search box, or both.
The column is of type integer and the display is a drop-down list which is
preinitialized from a second table structured in a particular way.
Parameters:
table - Name of table for datastore
Parameters:
column - Name of column for datastore
Parameters:
caption - Caption for search box and/or list box, or null
Parameters:
flags - Bitwise-OR combination of PRIMARY_KEY, etc. 0 = default.
Parameters:
initName - Name of table used to initialized, also name of its primary integer column.
Parameters:
descName - Name of description column in initialization table. |
| addPreInitRadioButtonGroup | | public HtmlComponent addPreInitRadioButtonGroup(String table, String column, String caption, int flags, String initName, String descName) throws Exception(Code) | | Adds a column to the data store and list box, search box, or both.
The column is of type integer and the display is a drop-down list which is
preinitialized from a second table structured in a particular way.
Parameters:
table - Name of table for datastore
Parameters:
column - Name of column for datastore
Parameters:
caption - Caption for search box and/or list box, or null
Parameters:
flags - Bitwise-OR combination of PRIMARY_KEY, etc. 0 = default.
Parameters:
initName - Name of table used to initialized, also name of its primary integer column.
Parameters:
descName - Name of description column in initialization table. |
| addPreInitRadioButtonGroup | | public HtmlComponent addPreInitRadioButtonGroup(String table, String column, String caption, int flags, String initTable, String initName, String descName) throws Exception(Code) | | Adds a column to the data store and list box, search box, or both.
The column is of type integer and the display is a drop-down list which is
preinitialized from a second table structured in a particular way.
Parameters:
table - Name of table for datastore
Parameters:
column - Name of column for datastore
Parameters:
caption - Caption for search box and/or list box, or null
Parameters:
flags - Bitwise-OR combination of PRIMARY_KEY, etc. 0 = default.
Parameters:
initName - Name of table used to initialized, also name of its primary integer column.
Parameters:
descName - Name of description column in initialization table. |
| addPreInitStringDropDown | | public HtmlComponent addPreInitStringDropDown(String table, String column, String caption, int flags, String initTable, String initName, String descName) throws Exception(Code) | | Adds a column to the data store and list box, search box, or both.
The column is of type integer and the display is a drop-down list which is
preinitialized from a second table structured in a particular way.
Parameters:
table - Name of table for datastore
Parameters:
column - Name of column for datastore
Parameters:
caption - Caption for search box and/or list box, or null
Parameters:
flags - Bitwise-OR combination of PRIMARY_KEY, etc. 0 = default.
Parameters:
initName - Name of table used to initialized, also name of its primary integer column.
Parameters:
descName - Name of description column in initialization table. |
| addPreInitStringRadioButtonGroup | | public HtmlComponent addPreInitStringRadioButtonGroup(String table, String column, String caption, int flags, String initTable, String initName, String descName) throws Exception(Code) | | Adds a column to the data store and list box, search box, or both.
The column is of type integer and the display is a drop-down list which is
preinitialized from a second table structured in a particular way.
Parameters:
table - Name of table for datastore
Parameters:
column - Name of column for datastore
Parameters:
caption - Caption for search box and/or list box, or null
Parameters:
flags - Bitwise-OR combination of PRIMARY_KEY, etc. 0 = default.
Parameters:
initName - Name of table used to initialized, also name of its primary integer column.
Parameters:
descName - Name of description column in initialization table. |
| addSearchBoxHeadingComponent | | public void addSearchBoxHeadingComponent(HtmlComponent c)(Code) | | Adds a given component to heading of search box.
|
| addSearchComponent | | public HtmlFormComponent addSearchComponent(String name, String caption, int type, int flags) throws Exception(Code) | | Creates an entry component for the search box and returns it. The data store is not
affected.
Parameters:
name - Name to use for component.
Parameters:
caption - Caption for search box and/or list box, or null
Parameters:
type - Type of datastore column, using DataStore.DATATYPE_* values
Parameters:
flags - Bitwise-OR combination of PRIMARY_KEY, etc. 0 = default. |
| addSearchDisplay | | public HtmlComponent addSearchDisplay(String name, String caption, HtmlComponent component, int flags) throws Exception(Code) | | Adds a component to the Search display box.
Parameters:
name - Name to associate internally with the search component.
Parameters:
caption - Text of caption to put before the search component, or null.
Parameters:
component - The search component.
Parameters:
flags - Bitwise-OR combination of SAME_ROW, PRECEDENCE, etc. |
| addSearchDisplay | | public HtmlComponent addSearchDisplay(String name, String caption, HtmlComponent component, int flags, HtmlTableCellProperties propCaption, HtmlTableCellProperties propSearch) throws Exception(Code) | | Adds a component to the Search display box.
Parameters:
name - Name to associate internally with the search component.
Parameters:
caption - Text of caption to put before the search component, or null.
Parameters:
component - The search component.
Parameters:
flags - Bitwise-OR combination of SAME_ROW, PRECEDENCE, etc.
Parameters:
propCaption - Table properties for caption, or null.
Parameters:
propSearch - Table properties for search component, or null. |
| addStringDropDown | | public HtmlComponent addStringDropDown(String table, String column, String caption, int flags, String values, String displayValues) throws Exception(Code) | | Adds a column to the data store and list box, search box, or both.
The column is of type integer and the display is a drop-down list.
Parameters:
table - Name of table for datastore
Parameters:
column - Name of column for datastore
Parameters:
caption - Caption for search box and/or list box, or null
Parameters:
flags - Bitwise-OR combination of PRIMARY_KEY, etc. 0 = default. int[] values A list of values for the column. String[] dispValues A list of corresponding display values for each of the values for the column. |
| addStringDropDown | | public HtmlComponent addStringDropDown(String table, String column, String caption, int flags, String values, String displayValues, boolean isMandatory) throws Exception(Code) | | Adds a column to the data store and list box, search box, or both.
The column is of type integer and the display is a drop-down list.
Parameters:
table - Name of table for datastore
Parameters:
column - Name of column for datastore
Parameters:
caption - Caption for search box and/or list box, or null
Parameters:
flags - Bitwise-OR combination of PRIMARY_KEY, etc. 0 = default. int[] values A list of values for the column. String[] dispValues A list of corresponding display values for each of the values for the column. |
| addStringRadioButtonGroup | | public HtmlComponent addStringRadioButtonGroup(String table, String column, String caption, int flags, String values, String displayValues) throws Exception(Code) | | Adds a column to the data store and list box, search box, or both.
The column is of type integer and the display is a radio button group.
Parameters:
table - Name of table for datastore
Parameters:
column - Name of column for datastore
Parameters:
caption - Caption for search box and/or list box, or null
Parameters:
flags - Bitwise-OR combination of PRIMARY_KEY, etc. 0 = default. int[] values A list of values for the column. String[] dispValues A list of corresponding display values for each of the values for the column. |
| addStringRadioButtonGroup | | public HtmlComponent addStringRadioButtonGroup(String table, String column, String caption, int flags, String values, String displayValues, String defaultVal) throws Exception(Code) | | Adds a column to the data store and list box, search box, or both.
The column is of type integer and the display is a radio button group.
Parameters:
table - Name of table for datastore
Parameters:
column - Name of column for datastore
Parameters:
caption - Caption for search box and/or list box, or null
Parameters:
flags - Bitwise-OR combination of PRIMARY_KEY, etc. 0 = default. int[] values A list of values for the column. String[] dispValues A list of corresponding display values for each of the values for the column.
Parameters:
defaultVal - java.lang.String The defalt Radio Button you want selected |
| addStringRadioButtonGroup | | public HtmlComponent addStringRadioButtonGroup(String table, String column, String caption, int flags, String values, String displayValues, String defaultVal, HtmlTableCellProperties propCaption, HtmlTableCellProperties propSearch) throws Exception(Code) | | Adds a column to the data store and list box, search box, or both.
The column is of type integer and the display is a radio button group.
Parameters:
table - Name of table for datastore
Parameters:
column - Name of column for datastore
Parameters:
caption - Caption for search box and/or list box, or null
Parameters:
flags - Bitwise-OR combination of PRIMARY_KEY, etc. 0 = default. int[] values A list of values for the column. String[] dispValues A list of corresponding display values for each of the values for the column.
Parameters:
defaultVal - java.lang.String The defalt Radio Button you want selected
Parameters:
propCaption - HtmlTableCellProperties
Parameters:
propSearch - HtmlTableCellProperties |
| doRetrieve | | public void doRetrieve()(Code) | | Retrieve from database table into datastore according to search criteria.
|
| findOrAdd | | protected int findOrAdd(String name)(Code) | | Gets the object container matching the name. If not existing, create a new
one and add to list.
Index of container in list.
Parameters:
name - java.lang.String |
| getAdvancedSearchCaption | | public String getAdvancedSearchCaption()(Code) | | Get advanced caption of the Advanced Search Link.
|
| getBaseListFormComponents | | public Enumeration getBaseListFormComponents()(Code) | | Returns a list of all search components.
Enumeration |
| getBasicSearchCaption | | public String getBasicSearchCaption()(Code) | | Get the Basic caption of the Advanced Search Link.
|
| getContainer | | protected BaseListFormComponent getContainer(String name)(Code) | | Gets the object container matching the name, else null.
ThreeObjectContainer
Parameters:
name - java.lang.String |
| getDataStore | | public DataStore getDataStore()(Code) | | Return the internal DataStore object.
com.salmonllc.sql.DataStore |
| getListBox | | public HtmlDisplayBox getListBox()(Code) | | Returns display box component for list box.
com.salmonllc.html.HtmlDisplayBox |
| getListComponent | | public HtmlComponent getListComponent(String name)(Code) | | Returns component in list box associated with given name, or null.
com.salmonllc.html.HtmlComponent
Parameters:
name - String Name in form table.column |
| getListLinkComponent | | public HtmlComponent getListLinkComponent(String name)(Code) | | Returns component in list box associated with given name, or null.
com.salmonllc.html.HtmlComponent
Parameters:
name - String Name in form table.column |
| getListTable | | public HtmlDataTable getListTable()(Code) | | Returns the data-table instance used for list box.
HtmlDataTable |
| getSearchBox | | public HtmlDisplayBox getSearchBox()(Code) | | Returns display box component for search box.
com.salmonllc.html.HtmlDisplayBox |
| getSearchComponent | | public HtmlComponent getSearchComponent(String name)(Code) | | Returns component in search box associated with given name, or null.
com.salmonllc.html.HtmlComponent
Parameters:
name - java.lang.String Name in form table.column |
| getSearchComponents | | public Enumeration getSearchComponents()(Code) | | Returns a list of all search components.
Enumeration |
| getSearchCriteria | | public String getSearchCriteria()(Code) | | Gets the criteria that will be used for the retrieve
|
| makeComponent | | protected HtmlFormComponent makeComponent(String name, int type)(Code) | | Does the work of creating a component according to type.
com.salmonllc.html.HtmlFormComponent
Parameters:
name - java.lang.String
Parameters:
type - int |
| newRadioButtonGroup | | protected HtmlRadioButtonGroup newRadioButtonGroup(String name, int values, String displayValues, String defaultVal)(Code) | | Creates an integer-type radio-button group list like HtmlComponenFactory but tailored
to needs of the forms subclasses.
HtmlRadioButtonGroup
Parameters:
name - java.lang.String
Parameters:
values - int[]
Parameters:
displayValues - java.lang.String[]
Parameters:
defaultVal - java.lang.String |
| newRadioButtonGroup | | protected HtmlRadioButtonGroup newRadioButtonGroup(String name, String values, String displayValues, String defaultVal)(Code) | | Creates an integer-type radio-button group list like HtmlComponenFactory but tailored
to needs of the forms subclasses.
HtmlRadioButtonGroup
Parameters:
name - java.lang.String
Parameters:
values - int[]
Parameters:
displayValues - java.lang.String[]
Parameters:
defaultVal - java.lang.String |
| pageRequested | | public void pageRequested(PageEvent p) throws Exception(Code) | | This event will get fired each time a page is requested by the browser.
|
| parseDate | | protected Date parseDate(String sValue) throws ParseException(Code) | | This method was created to parse a date string
and return a valid java.util.Date object .
java.util.Date
Parameters:
sValue - java.lang.String |
| processSearchComponent | | protected void processSearchComponent(int i, CriteriaString cr) throws Exception(Code) | | Process a search component.
Parameters:
i - 0-based index to _elements
Parameters:
cr - CriteriaString |
| processSearchCompositeComponent | | protected void processSearchCompositeComponent(HtmlComposite composite, CriteriaString cr) throws Exception(Code) | | Process a search component.
Parameters:
composite - com.salmonllc.html.HtmlComposite look through composite and set criteria for each component inside
Parameters:
cr - CriteriaString |
| removeParameterKey | | public void removeParameterKey(String pageParam)(Code) | | Removes param from list of parameters
Parameters:
pageParam - Parameter to pass on during an add operation |
| resetParameters | | public void resetParameters()(Code) | | Resets keys and values to empty.
|
| setAddImage | | public void setAddImage(HtmlSubmitImage img)(Code) | | Replaces default search button (if any) with a submit image
Parameters:
The - SumbitImage to use for the search button. |
| setAddImage | | public void setAddImage(String imageUrl)(Code) | | Replaces default add button (if any) with an image button
Parameters:
imageUrl - URL of image. |
| setAdvancedSearchCaption | | public void setAdvancedSearchCaption(String caption)(Code) | | Set caption of the Advanced Search Link.
|
| setBasicSearchCaption | | public void setBasicSearchCaption(String caption)(Code) | | Set basic caption of the Advanced Search Link.
|
| setLinkFont | | public void setLinkFont(String font)(Code) | | Sets the font used for HtmlLink components created by the form. Default is
FONT_LINK.
Parameters:
font - java.lang.String |
| setListBoxCaption | | public void setListBoxCaption(String caption)(Code) | | Set heading caption of list box.
|
| setParameterValue | | public void setParameterValue(String pageParam, String value, boolean extend)(Code) | | Adds to a list of Parameters to pass on during an add operation.
Parameters:
pageParam - String Parameter to associate key with
Parameters:
value - String Value of key
Parameters:
extend - boolean should we add another value to this key(ex. if extend ==true : &key1=abc&key1=def&key1=ghi)(ex. if extend ==false : &key1=abc) |
| setSearchBoxCaption | | public void setSearchBoxCaption(String caption)(Code) | | Set heading caption of search box.
|
| setSearchImage | | public void setSearchImage(HtmlSubmitImage img)(Code) | | Replaces default search button (if any) with a submit image
Parameters:
The - SumbitImage to use for the search button. |
| setSearchImage | | public void setSearchImage(String imageUrl)(Code) | | Replaces default search button (if any) with an image button
Parameters:
imageUrl - URL of image. |
| showAddButton | | public void showAddButton(boolean visible)(Code) | | This method toggles the visiblity of the default add button.
Parameters:
visible - boolean |
| showSearchButton | | public void showSearchButton(boolean visible)(Code) | | This method toggles the visiblity of the default search button.
Parameters:
visible - boolean |
| submitPerformed | | public boolean submitPerformed(SubmitEvent e) throws Exception(Code) | | Inherited abstract method.
boolean
Parameters:
e - com.salmonllc.html.events.SubmitEvent |
|
|