| |
|
| com.salmonllc.jsp.JspContainer com.salmonllc.jsp.JspDisplayBox com.salmonllc.jsp.JspFormDisplayBox com.salmonllc.jsp.JspListFormDisplayBox
JspListFormDisplayBox | public class JspListFormDisplayBox extends JspFormDisplayBox implements SubmitListener(Code) | | An extended version of the display box with addional functionality for building list forms
|
MODE_DISPLAY_MULTI_PAGE | final public static int MODE_DISPLAY_MULTI_PAGE(Code) | | |
MODE_DISPLAY_SINGLE_PAGE | final public static int MODE_DISPLAY_SINGLE_PAGE(Code) | | |
MODE_EDIT | final public static int MODE_EDIT(Code) | | |
autoBindComponents | public void autoBindComponents() throws Exception(Code) | | Binds various components to the component based on their names passed to the constructor. CriteriaBuilder, CriteriaValidator and ListForm. This method is called by the framework and should not be called directly.
|
doDataStoreEstimateRowsRetrieved | public int doDataStoreEstimateRowsRetrieved(String criteria) throws Exception(Code) | | Override this method in subclasses to change the way the rows retrieved will be estimated
|
doDataStoreRetrieve | public void doDataStoreRetrieve(String where) throws Exception(Code) | | Override this method in subclasses to change the way the datastore is retrieved
|
doDataStoreUpdate | public void doDataStoreUpdate() throws Exception(Code) | | Override this method in subclasses to change the way the datastore is updated
|
doSave | public void doSave() throws Exception(Code) | | This method gets fired when the user clicks the save button. Subclasses can override it to customize behavior
|
getAddButtonCaption | public String getAddButtonCaption()(Code) | | Returns the add button visible or not
|
getButtonBgColor | public String getButtonBgColor()(Code) | | Returns the background color for the save and add buttons
|
getButtonDisplayLocation | public int getButtonDisplayLocation()(Code) | | the location for displaying the buttons |
getButtonFontStyle | public String getButtonFontStyle()(Code) | | Returns the font style for the save and add buttons
|
getDetailPageURL | protected String getDetailPageURL()(Code) | | Returns the url for the detail page this list form will zoom to
|
getLookupDescReturnEval | protected DataStoreEvaluator getLookupDescReturnEval()(Code) | | Returns the datastore evaluator used to process a return description from a lookup
|
getLookupReturnEval | protected DataStoreEvaluator getLookupReturnEval()(Code) | | Returns the datastore evaluator used to process a return from a lookup
|
getMaxRows | public int getMaxRows()(Code) | | returns the maximum number of rows the list is allowed to retrieve (-1 for unlimited)
|
getRowHighlightColor | public String getRowHighlightColor()(Code) | | the background color for the selected row |
getRowToEdit | public int getRowToEdit()(Code) | | Returns the last row selected when an edit link was clicked
|
getSaveButtonCaption | public String getSaveButtonCaption()(Code) | | Returns the text to display on the save button
|
getValidator | public HtmlValidatorText getValidator()(Code) | | returns the criteria validator the component is using to validate entered criteria
|
isAddButtonVisible | public boolean isAddButtonVisible()(Code) | | Return the add button visible or not
|
isDataModified | public boolean isDataModified()(Code) | | Returns true if the data in the list has been modified
|
isSaveButtonVisible | public boolean isSaveButtonVisible()(Code) | | Returns the save button visible or not
|
processLocaleInfo | protected void processLocaleInfo()(Code) | | |
setAddButtonAccessKey | public void setAddButtonAccessKey(String key)(Code) | | Set the access key for the add button
|
setAddButtonCaption | public void setAddButtonCaption(String caption)(Code) | | Sets the add button visible or not
|
setAddButtonVisible | public void setAddButtonVisible(boolean visible)(Code) | | Sets the add button visible or not
|
setAutoCreateLink | public void setAutoCreateLink(boolean autoCreate)(Code) | | Set to true to automatically create a link to zoom to a detail row (MODE_DISPLAY_MULTIPAGE, MODE_DISPLAY_SINGLE_PAGE only)
|
setButtonDisplayLocation | public void setButtonDisplayLocation(int loc)(Code) | | Sets the display location for a button. Valid values are BUTTON_DISPLAY_IN_HEADER and BUTTON_DISPLAY_BOX_BELOW_TABLE
|
setDetailFormName | public void setDetailFormName(String name)(Code) | | Called by the tag handler to set the name of the ListForm. The autoBindComponents will lookup the name of the component and attach it to this one or try to discover it if the name is null
|
setDetailPageFromSiteMap | public void setDetailPageFromSiteMap(String logicalName)(Code) | | Sets the url for the JSP page representing the detail page for this list page by looking up the page in the site map(MODE_DISPLAY_MULTIPAGE only)
|
setDetailPageURL | public void setDetailPageURL(String url)(Code) | | Sets the url for the JSP page representing the detail page for this list page (MODE_DISPLAY_MULTIPAGE only)
|
setDirtyDataErrorMessages | public void setDirtyDataErrorMessages(String _deleteErrorMessage, String _updateErrorMessage)(Code) | | Sets the error message for a dirty data exception
Parameters: _deleteErrorMessage - The message to display if a dirty data exception occurs on a deleted row Parameters: _updateErrorMessage - The message to display if a dirty data exception occurs on a updated row |
setLookupDescReturnExpression | public void setLookupDescReturnExpression(DataStoreExpression exp) throws DataStoreException(Code) | | If this component is being called from a lookup, the datastore expression to return to compute a description to return to the calling lookup
|
setLookupDescReturnExpression | public void setLookupDescReturnExpression(String exp) throws DataStoreException(Code) | | If this component is being called from a lookup, the datastore expression to return to compute a description to return to the calling lookup
|
setLookupReturnExpression | public void setLookupReturnExpression(String exp) throws DataStoreException(Code) | | If this component is being called from a lookup, the datastore expression to return to compute to return to the calling lookup
|
setLookupReturnExpression | public void setLookupReturnExpression(DataStoreExpression exp) throws DataStoreException(Code) | | If this component is being called from a lookup, the datastore expression to return to compute to return to the calling lookup
|
setMaxRows | public void setMaxRows(int i)(Code) | | sets the maximum number of rows the list is allowed to retrieve (-1 for unlimited)
|
setMaxRowsErrorMessage | public void setMaxRowsErrorMessage(String string)(Code) | | sets the error message that will be displayed when the maximum number of rows would be exceeded
|
setRowHighlightColor | public void setRowHighlightColor(String string)(Code) | | Sets the background color for the selected row
|
setRowToEdit | public void setRowToEdit(int row)(Code) | | Sets the the row in the table to edit
|
setSaveButtonAccessKey | public void setSaveButtonAccessKey(String key)(Code) | | Set the access key for the save button
|
setSaveButtonCaption | public void setSaveButtonCaption(String caption)(Code) | | Sets the text to display on the save button
|
setSaveButtonVisible | public void setSaveButtonVisible(boolean visible)(Code) | | Sets the save button visible or not
|
setSearchFormName | public void setSearchFormName(String name)(Code) | | Called by the tag handler to set the name of the ListForm. The autoBindComponents will lookup the name of the component and attach it to this one or try to discover it if the name is null
|
setTheme | public void setTheme(String theme)(Code) | | Sets the theme for the component
|
setUpButtons | protected void setUpButtons()(Code) | | |
setValidatorName | public void setValidatorName(String name)(Code) | | Called by the tag handler to set the name of the validator. The autoBindComponents will lookup the name of the component and attach it to this one or try to discover it if the name is null
|
updateLocale | public void updateLocale()(Code) | | Updates the display box button labels for the current language
The language property file must have the following key structure
FormDisplayBox.add represents the caption for the add button.
FormDisplayBox.save represents the caption for the save button.
FormDisplayBox.undo represents the caption for the ok button.
ListFormDisplayBox.dirtyDataDeleteError represents the error message that occurs when a dirty data exception occurs on a deleted row
ListFormDisplayBox.dirtyDataUpdateError represents the error message that occurs when a dirty data exception occurs on an updated row
ListFormDisplayBox.maxRowsExceededError represents the error message that occurs when trying to load more data then is allowed
|
|
|
|