| java.lang.Object
 com.salmonllc.html.HtmlComponent
com.salmonllc.html.HtmlTreeControl
| Method Summary | |
| public void | addPropertyExpression(Object comp, String propertyName, DataStoreBuffer dsb, DataStoreExpression propExpression)
This method will add a property expression to the HtmlTree.
The propExpression will be evaluated for each row in the DataStore and the set method for the specified property will be called on the specified object.
Parameters:
comp - The component to set the property for
Parameters:
propertyName - The name of the property to set. | | public void | addPropertyExpression(Object comp, String propertyName, DataStoreBuffer dsb, String expression)
The propExpression will be evaluated for each row in the DataStore and the set method for the specified property will be called on the specified object.
Parameters:
comp - The component to set the property for
Parameters:
propertyName - The name of the property to set. | | public void | addPropertyExpression(Object comp, String propertyName, DataStoreEvaluator expEval)
The propExpression will be evaluated by the evaluated for each row in the DataStore and the set method for the specified property will be called on the specified object.
Parameters:
comp - The component to set the property for
Parameters:
propertyName - The name of the property to set. | | public void | addSubmitListener(SubmitListener t)
Adds a listener that will be notified if the tree is submitted. | | public void | addTreeListener(TreeListener t)
Adds a listener that will be notified if a tree node is expanded or contracted. | | public void | callBack(TreeBuffer tb, PrintWriter p)
This method is used internally by the tree control and should not be executed directly. | | public void | clearBuffer()
| | public boolean | executeEvent(int type)
| | public void | generateHTML(PrintWriter writer, int rowNo)
| | public boolean | getAutoScroll()
| | public boolean | getClickSort()
| | 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 String | getTheme()
| | public TreeBuffer | getTreeBuffer()
This method returns the tree buffer that this component uses. | | public String | getWidth()
| | public boolean | processParms(Hashtable ht, int rowNo)
| | public void | processPropertyExpressions(int row)
| | public void | removeSubmitListener(SubmitListener t)
Removes a submit listener. | | public void | removeTreeListener(TreeListener t)
Removes a tree listener. | | public void | reset()
Adds a listener that will be notified if the tree is submitted. | | public void | setAutoScroll(boolean b)
| | public void | setClickSort(boolean b)
| | public void | setFont(String font)
This method will load the font start and end tags from the page properties object.See the Constants at the top of the class for valid values to pass to this method. | | 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 | setSystemImages(String expandImage, String contractImage, String nullImage)
This method sets the images that will appear on every tree item. | | public void | setTargetFrame(String f)
This method sets the frame that will be effected when the user selects an item in the tree. | | public void | setTheme(String theme)
This method sets the property theme for the component. | | public void | setTreeBuffer(TreeBuffer tb)
This method sets the tree buffer that this component uses. | | public void | setUsePathForClickSort(boolean usePath)
| | public void | setWidth(String string)
| | public void | sort(int sortColumn, int sortPathDir, int sortDir)
| | public void | sort(int sortColumn, int sortDir)
| | public void | sort()
|
| addPropertyExpression | | public void addPropertyExpression(Object comp, String propertyName, DataStoreBuffer dsb, DataStoreExpression propExpression) throws NoSuchMethodException, DataStoreException(Code) | | This method will add a property expression to the HtmlTree.
The propExpression will be evaluated for each row in the DataStore and the set method for the specified property will be called on the specified object.
Parameters:
comp - The component to set the property for
Parameters:
propertyName - The name of the property to set. The component must have a corresponding setProperty method or this method will throw a NoSuchMethodException
Parameters:
propExpression - com.salmonllc.html.PropertyExpression The instance of PropertyExpression that should do the evaluating.
exception:
java.lang.NoSuchMethodException - The exception description.
exception:
com.salmonllc.sql.DataStoreException - The exception description. |
| addPropertyExpression | | public void addPropertyExpression(Object comp, String propertyName, DataStoreBuffer dsb, String expression) throws NoSuchMethodException, DataStoreException(Code) | | The propExpression will be evaluated for each row in the DataStore and the set method for the specified property will be called on the specified object.
Parameters:
comp - The component to set the property for
Parameters:
propertyName - The name of the property to set. The component must have a corresponding setProperty method or this method will throw a NoSuchMethodException
Parameters:
expression - java.lang.String The datastore expression to evaluate
exception:
java.lang.NoSuchMethodException - The exception description.
exception:
com.salmonllc.sql.DataStoreException - The exception description. |
| addPropertyExpression | | public void addPropertyExpression(Object comp, String propertyName, DataStoreEvaluator expEval) throws NoSuchMethodException, DataStoreException(Code) | | The propExpression will be evaluated by the evaluated for each row in the DataStore and the set method for the specified property will be called on the specified object.
Parameters:
comp - The component to set the property for
Parameters:
propertyName - The name of the property to set. The component must have a corresponding setProperty method or this method will throw a NoSuchMethodException
Parameters:
expEval - DataStoreEvaluator The datastore evaluator that evaluates the expression
exception:
java.lang.NoSuchMethodException - The exception description.
exception:
com.salmonllc.sql.DataStoreException - The exception description. |
| addSubmitListener | | public void addSubmitListener(SubmitListener t)(Code) | | Adds a listener that will be notified if the tree is submitted.
|
| addTreeListener | | public void addTreeListener(TreeListener t)(Code) | | Adds a listener that will be notified if a tree node is expanded or contracted.
|
| callBack | | public void callBack(TreeBuffer tb, PrintWriter p)(Code) | | This method is used internally by the tree control and should not be executed directly.
|
| clearBuffer | | public void clearBuffer()(Code) | | This method will remove all elements from the Tree
|
| getAutoScroll | | public boolean getAutoScroll()(Code) | | true if the tree will automatically scroll to the location of the previous submit |
| getClickSort | | public boolean getClickSort()(Code) | | Returns whether click sort on the heading components is enabled
|
| getFontEndTag | | public String getFontEndTag()(Code) | | This method gets the end font tag for the component.
|
| getFontStartTag | | public String getFontStartTag()(Code) | | This method gets the start font tag for the component.
|
| getTheme | | public String getTheme()(Code) | | Returns the theme the tree is using
|
| getTreeBuffer | | public TreeBuffer getTreeBuffer()(Code) | | This method returns the tree buffer that this component uses.
The tree buffer is the class that maintains the state of the items on the tree.
|
| getWidth | | public String getWidth()(Code) | | the width of the tree table |
| processPropertyExpressions | | public void processPropertyExpressions(int row)(Code) | | |
| removeSubmitListener | | public void removeSubmitListener(SubmitListener t)(Code) | | Removes a submit listener.
|
| removeTreeListener | | public void removeTreeListener(TreeListener t)(Code) | | Removes a tree listener.
|
| reset | | public void reset()(Code) | | Adds a listener that will be notified if the tree is submitted.
|
| setAutoScroll | | public void setAutoScroll(boolean b)(Code) | | set to true for thee tree to automatically scroll page to the location it was on as of the previous submit
|
| setClickSort | | public void setClickSort(boolean b)(Code) | | Set to true to allow heading components to do a click sort
|
| setFont | | public void setFont(String font)(Code) | | This method will load the font start and end tags from the page properties object.See the Constants at the top of the class for valid values to pass to this method.
|
| setFontEndTag | | public void setFontEndTag(String value)(Code) | | This method sets the end font tag for the component.
|
| setFontStartTag | | public void setFontStartTag(String value)(Code) | | This method sets the start font tag for the component.
|
| setSystemImages | | public void setSystemImages(String expandImage, String contractImage, String nullImage)(Code) | | This method sets the images that will appear on every tree item. It must be called before the tree can be used.
Parameters:
expandImage - The image to use to expand a tree item.
Parameters:
contractImage - The image to use to contract a tree item.
Parameters:
nullImage - The image to use if a tree item can't be expanded or contracted. |
| setTargetFrame | | public void setTargetFrame(String f)(Code) | | This method sets the frame that will be effected when the user selects an item in the tree.
|
| setTheme | | public void setTheme(String theme)(Code) | | This method sets the property theme for the component.
Parameters:
theme - The theme to use. |
| setTreeBuffer | | public void setTreeBuffer(TreeBuffer tb)(Code) | | This method sets the tree buffer that this component uses.
The tree buffer is the class that maintains the state of the items on the tree.
|
| setUsePathForClickSort | | public void setUsePathForClickSort(boolean usePath)(Code) | | For a click sort, decide whether or not the first column (tree path) takes precidence to the column being sorted
|
| setWidth | | public void setWidth(String string)(Code) | | sets the width of the table
|
| sort | | public void sort(int sortColumn, int sortPathDir, int sortDir)(Code) | | Sort the tree
Parameters:
column - the number of the header column to sort on (0 for path name only sort)
Parameters:
pathDir - the sort direction for the tree path (first column) to sort on TreeBuffer.SORT_ASC or TreeBuffer.SORT_DES or TreeBuffer.SORT_ANY to not use a path sort
Parameters:
dir - the direction to sort the specified column on SORT_ASC or SORT_DES if column is not zero |
| sort | | public void sort(int sortColumn, int sortDir)(Code) | | Sort the tree on a column
Parameters:
column - the number of the header column to sort on (0 for path name only sort)
Parameters:
dir - the direction to sort the specified column on SORT_ASC or SORT_DES if column is not zero |
|
|