Java Doc for JspListFormDisplayBox.java in  » J2EE » Sofia » com » salmonllc » jsp » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » J2EE » Sofia » com.salmonllc.jsp 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


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


Field Summary
final public static  intMODE_DISPLAY_MULTI_PAGE
    
final public static  intMODE_DISPLAY_SINGLE_PAGE
    
final public static  intMODE_EDIT
    

Constructor Summary
public  JspListFormDisplayBox(String name, int mode, HtmlPage page)
    
public  JspListFormDisplayBox(String name, int mode, String theme, HtmlPage page)
    

Method Summary
public  voidaddButton(HtmlSubmitButton b)
    
public  voidautoBindComponents()
     Binds various components to the component based on their names passed to the constructor.
public  voiddoAdd()
     This method gets fired when the user clicks the add button.
public  intdoDataStoreEstimateRowsRetrieved(String criteria)
    
public  voiddoDataStoreRetrieve(String where)
    
public  voiddoDataStoreUpdate()
    
public  voiddoEdit()
     This method gets fired when the user clicks an edit link.
public  voiddoSave()
     This method gets fired when the user clicks the save button.
public  voiddoSearch()
    
public  voidgenerateHTML(TagWriter t, String boxBody)
    
public  HtmlSubmitButtongetAddButton()
    
public  StringgetAddButtonCaption()
    
public  StringgetButtonBgColor()
    
public  intgetButtonDisplayLocation()
    
public  StringgetButtonFontStyle()
    
public  DataStoreBuffergetDataStore()
    
public  JspDataTablegetDataTable()
    
protected  StringgetDetailPageURL()
    
protected  DataStoreEvaluatorgetLookupDescReturnEval()
    
protected  DataStoreEvaluatorgetLookupReturnEval()
    
public  intgetMaxRows()
    
public  StringgetRowHighlightColor()
    
public  intgetRowToEdit()
    
public  HtmlSubmitButtongetSaveButton()
    
public  StringgetSaveButtonCaption()
    
public  HtmlValidatorTextgetValidator()
    
public  booleanisAddButtonVisible()
    
public  booleanisDataModified()
    
public  booleanisSaveButtonVisible()
    
protected  voidprocessLocaleInfo()
    
public  voidreturnValueToLookup(int row)
    
public  voidsetAddButtonAccessKey(String key)
    
public  voidsetAddButtonCaption(String caption)
    
public  voidsetAddButtonVisible(boolean visible)
    
public  voidsetAutoCreateLink(boolean autoCreate)
    
public  voidsetButtonDisplayLocation(int loc)
     Sets the display location for a button.
public  voidsetDetailFormName(String name)
     Called by the tag handler to set the name of the ListForm.
public  voidsetDetailPageFromSiteMap(String logicalName)
    
public  voidsetDetailPageURL(String url)
    
public  voidsetDirtyDataErrorMessages(String _deleteErrorMessage, String _updateErrorMessage)
    
public  voidsetLookupDescReturnExpression(DataStoreExpression exp)
    
public  voidsetLookupDescReturnExpression(String exp)
    
public  voidsetLookupReturnExpression(String exp)
    
public  voidsetLookupReturnExpression(DataStoreExpression exp)
    
public  voidsetMaxRows(int i)
    
public  voidsetMaxRowsErrorMessage(String string)
    
public  voidsetRowHighlightColor(String string)
    
public  voidsetRowToEdit(int row)
    
public  voidsetSaveButtonAccessKey(String key)
    
public  voidsetSaveButtonCaption(String caption)
    
public  voidsetSaveButtonVisible(boolean visible)
    
public  voidsetSearchFormName(String name)
     Called by the tag handler to set the name of the ListForm.
public  voidsetTheme(String theme)
    
protected  voidsetUpButtons()
    
public  voidsetValidatorName(String name)
     Called by the tag handler to set the name of the validator.
public  booleansubmitPerformed(SubmitEvent e)
    
public  voidupdateLocale()
    

Field Detail
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)




Constructor Detail
JspListFormDisplayBox
public JspListFormDisplayBox(String name, int mode, HtmlPage page)(Code)



JspListFormDisplayBox
public JspListFormDisplayBox(String name, int mode, String theme, HtmlPage page)(Code)




Method Detail
addButton
public void addButton(HtmlSubmitButton b)(Code)
Adds a button to the display box



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.



doAdd
public void doAdd() throws SQLException, DataStoreException, Exception(Code)
This method gets fired when the user clicks the add button. Subclasses can override it to customize behavior



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



doEdit
public void doEdit() throws SQLException, DataStoreException, Exception(Code)
This method gets fired when the user clicks an edit link. Subclasses can override it to customize behavior



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



doSearch
public void doSearch() throws SQLException, DataStoreException, Exception(Code)



generateHTML
public void generateHTML(TagWriter t, String boxBody) throws Exception(Code)



getAddButton
public HtmlSubmitButton getAddButton()(Code)
the add button used by this component



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



getDataStore
public DataStoreBuffer getDataStore()(Code)



getDataTable
public JspDataTable getDataTable()(Code)



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



getSaveButton
public HtmlSubmitButton getSaveButton()(Code)
the save button used by this component



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)



returnValueToLookup
public void returnValueToLookup(int row) throws DataStoreException, IOException(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



submitPerformed
public boolean submitPerformed(SubmitEvent e) throws Exception(Code)
framework method, do not call directly



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



Fields inherited from com.salmonllc.jsp.JspFormDisplayBox
final public static String ALIGN_CENTER(Code)(Java Doc)
final public static String ALIGN_LEFT(Code)(Java Doc)
final public static String ALIGN_RIGHT(Code)(Java Doc)
final public static int BUTTON_DISPLAY_BELOW_TABLE(Code)(Java Doc)
final public static int BUTTON_DISPLAY_IN_HEADER(Code)(Java Doc)
final public static int BUTTON_DISPLAY_IN_HEADER_AND_BELOW_TABLE(Code)(Java Doc)
protected String _bottomButtonAlign(Code)(Java Doc)
protected String _buttonBgColor(Code)(Java Doc)
protected int _buttonDisplayLocation(Code)(Java Doc)
protected String _buttonFontStyle(Code)(Java Doc)
protected ArrayList _buttons(Code)(Java Doc)
protected ArrayList _hidden(Code)(Java Doc)
protected ArrayList _messageButtons(Code)(Java Doc)
protected String _okButtonCap_cancelButtonCap_undoButtonCap(Code)(Java Doc)
protected boolean _updateLocale(Code)(Java Doc)
protected HtmlValidatorText _validator(Code)(Java Doc)
protected boolean _validatorBuiltInternally(Code)(Java Doc)

Methods inherited from com.salmonllc.jsp.JspFormDisplayBox
protected void addConfirmScript(String message, HtmlHiddenField hidden)(Code)(Java Doc)
abstract public void autoBindComponents() throws Exception(Code)(Java Doc)
public static String buildWhereFromDsRow(DataStore dsb, int row) throws DataStoreException(Code)(Java Doc)
protected HtmlFormComponent findFirstFormComponent(JspContainer cont)(Code)(Java Doc)
protected HtmlText findFirstTextComponent(JspContainer cont)(Code)(Java Doc)
protected HtmlCheckBox findFirstUnboundCheckBox(JspContainer cont)(Code)(Java Doc)
public void generateHTML(TagWriter t, String boxBody) throws Exception(Code)(Java Doc)
public String getBottomButtonAlign()(Code)(Java Doc)
protected boolean[] getButtonsVisible()(Code)(Java Doc)
public String getCancelButtonCap()(Code)(Java Doc)
protected String getLookupReturnToURL(String keyVal, String descVal)(Code)(Java Doc)
public String getOkButtonCap()(Code)(Java Doc)
public String getUndoButtonCap()(Code)(Java Doc)
protected boolean isFromLookup()(Code)(Java Doc)
protected boolean isFromPopupLookup()(Code)(Java Doc)
protected void processLocaleInfo()(Code)(Java Doc)
public void setBottomButtonAlign(String string)(Code)(Java Doc)
public void setButtonBgColor(String bgColor)(Code)(Java Doc)
public void setButtonFontStyle(String style)(Code)(Java Doc)
protected void setButtonVisible(boolean vis)(Code)(Java Doc)
public void setCancelButtonCap(String string)(Code)(Java Doc)
public void setOkButtonCap(String string)(Code)(Java Doc)
public void setTheme(String theme)(Code)(Java Doc)
public void setUndoButtonCap(String string)(Code)(Java Doc)
protected void setUpButtons()(Code)(Java Doc)
public void setVisible(boolean vis)(Code)(Java Doc)
public void updateLocale()(Code)(Java Doc)

Fields inherited from com.salmonllc.jsp.JspDisplayBox
final public static int SIZE_PERCENT(Code)(Java Doc)
final public static int SIZE_PIXELS(Code)(Java Doc)
protected String _fontEndTag(Code)(Java Doc)
protected String _fontStartTag(Code)(Java Doc)
String _headingCaption(Code)(Java Doc)

Methods inherited from com.salmonllc.jsp.JspDisplayBox
public void generateHTML(TagWriter t, String headingBody, String boxBody) throws java.io.IOException(Code)(Java Doc)
public String getBackgroundColor()(Code)(Java Doc)
public String getBodyClassname()(Code)(Java Doc)
public int getBorder()(Code)(Java Doc)
public int getCellPadding()(Code)(Java Doc)
public int getCellSpacing()(Code)(Java Doc)
public String getFont()(Code)(Java Doc)
public String getHeaderFont()(Code)(Java Doc)
public String getHeadingBackgroundColor()(Code)(Java Doc)
public String getHeadingCaption()(Code)(Java Doc)
public String getHeadingClassname()(Code)(Java Doc)
public int getInnerCellPadding()(Code)(Java Doc)
public int getInnerCellSpacing()(Code)(Java Doc)
public String getTheme()(Code)(Java Doc)
public String getWidth()(Code)(Java Doc)
public boolean isHeadingSuppressed()(Code)(Java Doc)
public void setBackgroundColor(String color)(Code)(Java Doc)
public void setBodyClassname(String string)(Code)(Java Doc)
public void setBorder(int border)(Code)(Java Doc)
public void setCellPadding(int value)(Code)(Java Doc)
public void setCellSpacing(int value)(Code)(Java Doc)
public void setFont(String font)(Code)(Java Doc)
public void setFontEndTag(String value)(Code)(Java Doc)
public void setFontStartTag(String value)(Code)(Java Doc)
public void setHeaderFont(String fontName)(Code)(Java Doc)
public void setHeadingBackgroundColor(String color)(Code)(Java Doc)
public void setHeadingCaption(String text)(Code)(Java Doc)
public void setHeadingClassname(String string)(Code)(Java Doc)
public void setInnerCellPadding(int value)(Code)(Java Doc)
public void setInnerCellSpacing(int value)(Code)(Java Doc)
public void setTheme(String theme)(Code)(Java Doc)
public void setWidth(String width)(Code)(Java Doc)
public void suppressHeading(boolean supHead)(Code)(Java Doc)

Fields inherited from com.salmonllc.jsp.JspContainer
final public static int TYPE_COMP(Code)(Java Doc)
final public static int TYPE_FOOTER(Code)(Java Doc)
final public static int TYPE_GROUP_FOOTER(Code)(Java Doc)
final public static int TYPE_GROUP_HEADER(Code)(Java Doc)
final public static int TYPE_HEADER(Code)(Java Doc)
final public static int TYPE_ROW(Code)(Java Doc)
protected boolean _center(Code)(Java Doc)
protected boolean _enabled(Code)(Java Doc)
protected HtmlComponent _submit(Code)(Java Doc)

Methods inherited from com.salmonllc.jsp.JspContainer
public void add(HtmlComponent comp, int type)(Code)(Java Doc)
public void clearSubmit()(Code)(Java Doc)
public boolean executeEvent(int eventType) throws Exception(Code)(Java Doc)
public void generateHTML(PrintWriter p, int rowNo) throws java.lang.Exception(Code)(Java Doc)
public HtmlComponent getComponent(int i)(Code)(Java Doc)
public int getComponentCount()(Code)(Java Doc)
public int getComponentIndex(HtmlComponent comp)(Code)(Java Doc)
public int getComponentType(int i)(Code)(Java Doc)
public int getComponentType(HtmlComponent comp)(Code)(Java Doc)
public Enumeration getComponents()(Code)(Java Doc)
public JspController getController()(Code)(Java Doc)
public boolean getDoInit()(Code)(Java Doc)
public HtmlComponent getSubmitComponent()(Code)(Java Doc)
public void initialize()(Code)(Java Doc)
public boolean isComponentInContainer(HtmlComponent comp)(Code)(Java Doc)
public boolean processParms(Hashtable parms, int rowNo) throws Exception(Code)(Java Doc)
boolean replaceComponent(HtmlComponent comp, Object compToReplace)(Code)(Java Doc)
public void setDoInit(boolean b)(Code)(Java Doc)
public void setEnabled(boolean enabled)(Code)(Java Doc)
public void setVisible(boolean visible)(Code)(Java Doc)
public String toString()(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.