| java.lang.Object
 com.salmonllc.html.HtmlComponent
com.salmonllc.html.HtmlContainer
com.salmonllc.html.HtmlDataTable
All known Subclasses: com.salmonllc.html.HtmlDataTable2D,
| HtmlDataTable | | public class HtmlDataTable extends HtmlContainer implements ImageGenerator(Code) | | This component will generate an HTML table. It serves as a container and
layout manager for other components. There are several bands of components in
the page. Heading Components are displayed at the top of the table and occur
only once. Row Components are displayed below the heading components and are
repeated for each row in the DataStoreBuffer. Footer Components are displayed
at the end of the table. Control Break Header and Footer components are
displayed before and after a set of control break columns change.
|
| Method Summary | |
| public void | add(HtmlComponent comp)
This method should not be used in this type of container. | | public void | addBucket(String name, String heading, int type)
Creates a datastore bucket and corresponding display components for the
search and list boxes. | | public void | addBucket(String name, String heading, int type, String href, String format)
Creates a datastore bucket and corresponding display components for the
search and list boxes. | | public void | addBucket(String name, String heading, int type, String href, String format, HtmlTableCellProperties propList)
Creates a datastore bucket and corresponding display components for the
search and list boxes. | | public void | addColumn(String table, String column, String heading, int type)
Creates a datastore column and corresponding display components for the
search and list boxes. | | public void | addColumn(String table, String column, String heading, int type, String href)
Creates a datastore column and corresponding display components for the
search and list boxes. | | public void | addColumn(String table, String column, String heading, int type, String href, String format)
Creates a datastore column and corresponding display components for the
search and list boxes. | | public void | addColumn(String table, String column, String heading, int type, String href, String format, 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 | addColumn(String table, String column, String heading, int type, String href, String format, HtmlTableCellProperties propHeading, 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 | addDisplay(String fullColName, String heading, HtmlComponent component, HtmlTableCellProperties prop)
Adds a component to the List display. | | public void | addDisplay(String fullColName, String heading, HtmlComponent component, HtmlTableCellProperties propHeading, HtmlTableCellProperties propComponent)
Adds a component to the List display. | | public void | addPropertyExpression(Object comp, String propertyName, DataStoreEvaluator expEval)
This method will add a property expression to the HtmlDataTable. | | public void | addPropertyExpression(Object comp, String propertyName, DataStoreExpression propExpression)
This method will add a property expression to the HtmlDataTable. | | public void | addPropertyExpression(Object comp, String propertyName, String expression)
This method will add a property expression to the HtmlDataTable. | | public void | clearPropertyExpressions()
This method will remove all property expressions from the table. | | public boolean | executeEvent(int eventType)
| | protected HtmlComponent | findSortComponent(HtmlComponent sortComp)
| | public void | generateHTML(java.io.PrintWriter p, int rowNo)
| | public void | generateImage(String img, OutputStream out)
| | public void | generateInitialHTML(PrintWriter p)
| | public String | getAlign()
Returns the alignment property for the table. | | public String | getBackgroundColor()
Gets the background color for the table. | | protected String | getBackgroundColor(String currentColor)
| | public int | getBorder()
Gets the border thickness for the table. | | public long | getCacheKey()
| | public int | getCellPadding()
Gets the cell padding for the table. | | public int | getCellSpacing()
Gets the cell spacing for the table. | | public boolean | getClickSort()
Returns true if heading components should be underline links that sort
the list. | | public int | getColumnWidth(int column)
| | public Enumeration | getComponents()
This method returns all the elements in the container. | | public DataStoreBuffer | getDataStoreBuffer()
Returns the internal data store buffer used by the component. | | public boolean | getDidSubmit()
This method returns true if the datatable did the last submit of the page
through a sort or clicking on a paging button. | | public int | getFirstRowOnPage()
This method gets the first row displayed on the current page. | | protected Vector | getFooterComponents()
Gets a vector containing the components in the data table footer. | | public int | getFooterComponentsSize()
This method returns all the elements in the container. | | public boolean | getGenImagesForPagingButtons()
Gets whether the or not paging buttons will be generated images or
regular submit buttons. | | public boolean | getGenTHeadAndBody()
| | public HtmlComponent | getHeadingComponentAt(int pos)
This method returns the heading component at the specified position or
null if non is found. | | public HtmlComponent | getHeadingComponentAt(String name)
This method returns the heading component at that is the same as the name
specified or null if none is found. | | protected Vector | getHeadingComponents()
Gets a vector containing the components in the data table heading. | | public int | getHeadingComponentsSize()
This method returns all the elements in the container. | | public String | getHeadingStyleClassName()
| | public String | getLinkFont()
This method returns the font that is being used for links created with
addColumn. | | public int | getMaxPageButtons()
This method gets the maximum number of paging buttons to display. | | public int | getPage(int row)
This method returns the page the row is on. | | public int | getPageButtonType()
Gets the type of paging buttons for the data table. | | public Color | getPagingButtonBackgroundColor()
| | public Color | getPagingButtonBottomRightColor()
| | public String | getPagingButtonDisplayStyle()
This method gets the Display Style for a generated page button image. | | public Font | getPagingButtonFont()
| | public int | getPagingButtonHeight()
| | public Color | getPagingButtonTextColor()
| | public boolean | getRepeatHeadingsAfterBreak()
| | public HtmlComponent | getRowComponentAt(int pos)
This method returns the row component at the specified position or null
if non is found. | | public HtmlComponent | getRowComponentAt(String name)
This method returns the row component at that is the same as the name
specified or null if none is found. | | protected Vector | getRowComponents()
Gets a vector containing the components in a data table row. | | public int | getRowComponentsSize()
This method returns all the elements in the container. | | public String | getRowStyleClassName1()
| | public String | getRowStyleClassName2()
| | public int | getRowsPerPage()
This method gets the number of rows to display on one page of output. | | public String | getScrollAnchor()
This method gets the anchor to scroll to when a paging button on the
table is clicked. | | public boolean | getScrollOnClickSort()
Gets whether the datastore will build scrolling javascript when the user
clicks on a column heading to sort or a paging button. | | public boolean | getSelRowsPerPage()
Returns true if rows per page selector is visible. | | public int | getSizeOption()
This method returns the size option for the table and each cell in it. | | public int | getSortColumn()
This method returns the number of the last column that the user clicked
on to sort the list. | | public int | getSortDirection()
This method returns the direction of the sort set when the user last
clicked a column heading to sort the list. | | protected String | getStyle(String currentStyle)
| | public int | getTableHeight()
| | public String | getTheme()
This method returns the property theme for the component. | | public boolean | getUseCache()
If the image is dynamically generated, this method will indicate whether
or not the Objectstore should cache it. | | public boolean | getUseLinksForPagingButtons()
Gets whether the or not paging buttons will be links or submit. | | public int | getWidth()
This method returns the width of the table. | | public boolean | isRowOnPage(int row)
This method returns true if the specified row is on the current page. | | public boolean | processParms(Hashtable parms, int rowNo)
| | protected void | processPropertyExpressions(int row)
| | public void | removeAll()
| | public void | removeRowComponent(HtmlComponent comp)
Removes an html component from the row container. | | public void | reset()
| | public void | resetControlBreakFooterComponents()
This method will remove all Control Break Footer Components from the
DataTable. | | public void | resetControlBreakHeadingComponents()
This method will remove all Control Break Heading Components from the
DataTable. | | public void | resetFooterComponents()
This method will remove all Footer Components from the DataTable. | | public void | resetHeadingComponents()
This method will remove all Heading Components from the DataTable. | | public void | resetRowComponents()
This method will remove all Row Components from the DataTable. | | public void | setAlign(String align)
Sets the alignment property for the table. | | public void | setBackgroundColor(String value)
Sets the background color for the table. | | public void | setBaseClickSort(String column, int dir)
This method will set the base click sort column for the datastore. | | public void | setBorder(int border)
Sets the border width for the table. | | public void | setBreakColumns(int[] cols)
Use this method to set the columns that the Data Table will control break
on. | | public void | setBreakColumns(String[] cols)
Use this method to set the columns that the Data Table will control break
on. | | public void | setBreakColumns(int col)
Use this method to set the columns that the Data Table will control break
on. | | public void | setBreakColumns(String col)
Use this method to set the columns that the Data Table will control break
on. | | public void | setCacheKey(long key)
| | public void | setCellPadding(int value)
Sets the cell padding for the table. | | public void | setCellSpacing(int value)
Sets the cell spacing for the table. | | public void | setClickSort(boolean clickSort)
Set to true if heading components should be underline links that sort the
list. | | public void | setColumnWidth(int column, int width)
Sets the column width for a particular column in the table. | | public void | setContMessage(HtmlComponent comp)
Use this method to set a continuation message for an HtmlDataTable with
Control Break Columns. | | public void | setControlBreakFooterComponentAt(int column, HtmlComponent comp)
Sets a control break footer component at a particular row position in the
table. | | public void | setControlBreakFooterComponentAt(int column, HtmlComponent comp, HtmlTableCellProperties props)
Sets a control break footer component at a particular column position in
the table. | | public void | setControlBreakFooterComponents(HtmlComponent comp)
Sets all the control break footer components on a particular row in the
table. | | public void | setControlBreakFooterComponents(HtmlComponent comp, HtmlTableCellProperties props)
Sets all the control break footer components on a particular row in the
table. | | public void | setControlBreakHeadingComponentAt(int column, HtmlComponent comp)
Sets a control break heading component at a particular row position in
the table. | | public void | setControlBreakHeadingComponentAt(int column, HtmlComponent comp, HtmlTableCellProperties props)
Sets a control break heading component at a particular column position in
the table. | | public void | setControlBreakHeadingComponents(HtmlComponent comp)
Sets all the control break heading components on a particular row in the
table. | | public void | setControlBreakHeadingComponents(HtmlComponent comp, HtmlTableCellProperties props)
Sets all the control break heading components on a particular row in the
table. | | public void | setDataStore(DataStoreBuffer d)
Sets the internal data store used by the component. | | public void | setDisplayRowComponents(boolean display)
Use this method if you don't want the datatable to display the band with
row components. | | public void | setFirstRowOnPage(int firstRowOnPage)
This method sets the first row displayed on the current page. | | public void | setFooterComponentAt(int column, HtmlComponent comp)
Sets a footer component at a particular row position in the table. | | public void | setFooterComponentAt(int column, HtmlComponent comp, HtmlTableCellProperties props)
Sets a footer component at a particular row position in the table. | | public void | setFooterComponents(HtmlComponent comp)
Sets all the footer components on a particular row in the table. | | public void | setFooterComponents(HtmlComponent comp, HtmlTableCellProperties props)
Sets all the footer components on a particular row in the table. | | public void | setGenImagesForPagingButtons(boolean gen)
Sets whether the or not paging buttons will be generated images or
regular submit buttons. | | public void | setGenTHeadAndBody(boolean genTHeadAndBody)
| | public void | setHeadingBackgroundColor(String value)
| | public void | setHeadingComponentAt(int column, HtmlComponent comp)
Sets a heading component at a particular row position in the table. | | public void | setHeadingComponentAt(int column, HtmlComponent comp, HtmlTableCellProperties props)
Sets a heading component at a particular row position in the table. | | public void | setHeadingComponents(HtmlComponent comp)
Sets all the heading components on a particular row in the table. | | public void | setHeadingComponents(HtmlComponent comp, HtmlTableCellProperties props)
Sets all the heading components on a particular row in the table. | | public void | setHeadingStyleClassName(String string)
| | public void | setLinkFont(String font)
This method set which font will be used for links created with addColumn. | | public void | setMaxPageButtons(int max)
This method sets the maximum number of paging buttons to display. | | public void | setPage(int page)
| | public void | setPageBreak(boolean bAddPageBreak)
Adds a page break to this table for printing purposes (IE 5 and up only). | | public void | setPageBreakIndex(int idx)
| | public void | setPageButtonType(int type)
Sets the type of paging buttons for the data table. | | public void | setPageSelectRenderer(DataTablePageSelectRenderer r)
| | public void | setPageSelectRenderer(String r)
| | public void | setPagingButtonBackgroundColor(Color c)
| | public void | setPagingButtonBottomRightColor(Color c)
| | public void | setPagingButtonDisplayStyle(String style)
This method sets the Display Style for a generated image button. | | public void | setPagingButtonFont(Font f)
This method sets the font used for dynamically generated page button
images. | | public void | setPagingButtonHeight(int height)
| | public void | setRepeatHeadingsAfterBreak(boolean repeatHeadingsAfterBreak)
| | public void | setRowBackgroundColor1(String value)
Sets the background color for rows in the data table. | | public void | setRowBackgroundColor2(String value)
Sets the background color for rows in the data table. | | public void | setRowComponentAt(int column, HtmlComponent comp)
Sets a row component at a particular row position in the table. | | public void | setRowComponentAt(int column, HtmlComponent comp, HtmlTableCellProperties props)
Sets a row component at a particular row position in the table. | | public void | setRowComponents(HtmlComponent comp)
Sets a row component at a particular row position in the table. | | public void | setRowComponents(HtmlComponent comp, HtmlTableCellProperties props)
Sets a row component at a particular row position in the table. | | public void | setRowStyleClassName1(String string)
| | public void | setRowStyleClassName2(String string)
| | public void | setRowsPerPage(int rowsPerPage)
This method sets the number of rows to display on one page of output. | | public void | setRowsPerPageRenderer(DataTableRowsPerPageRenderer r)
| | public void | setRowsPerPageRenderer(String r)
| | public void | setScrollAnchor(String anchor)
This method sets the anchor to scroll to when a paging button on the
table is clicked. | | public void | setScrollOnClickSort(boolean scroll)
Sets whether the datastore will build scrolling javascript when the user
clicks on a column heading to sort or a paging button. | | public void | setSelRowsPerPage(boolean sel)
Sets whether rows per page selector is visible. | | public void | setSizeOption(int option)
This method sets the size option for the table and each cell in it. | | public void | setSummaryRowText(String summaryRowText)
This method sets the size option for the table and each cell in it. | | public void | setTableHeight(int tableHeight)
| | public void | setTheme(String theme)
This method sets the property theme for the component. | | public void | setUseCache(boolean useCache)
If the image is dynamically generated, this method will indicate whether
or not the Objectstore should cache it. | | public void | setUseLinksForPagingButtons(boolean gen)
Sets whether the or not paging buttons will be links or submit. | | public void | setWidth(int width)
This method sets the minimum width of the table in either pixels or
percent depending on size option. | | protected void | sortOnComponent(HtmlComponent comp, int colNo)
This method was created in VisualAge. |
| MAX_ROW_LIMIT | | final public static int MAX_ROW_LIMIT(Code) | | |
| PAGE_BUTTON_STYLE_OVAL | | final public static String PAGE_BUTTON_STYLE_OVAL(Code) | | |
| PAGE_BUTTON_STYLE_RECTANGLE | | final public static String PAGE_BUTTON_STYLE_RECTANGLE(Code) | | |
| PAGE_BUTTON_TYPE_IMAGE | | final public static int PAGE_BUTTON_TYPE_IMAGE(Code) | | |
| PAGE_BUTTON_TYPE_SCROLLBAR | | final public static int PAGE_BUTTON_TYPE_SCROLLBAR(Code) | | |
| PAGE_BUTTON_TYPE_SUBMIT | | final public static int PAGE_BUTTON_TYPE_SUBMIT(Code) | | |
| PAGE_BUTTON_TYPE_TEXT | | final public static int PAGE_BUTTON_TYPE_TEXT(Code) | | |
| SIZE_PERCENT | | final public static int SIZE_PERCENT(Code) | | |
| SIZE_PIXELS | | final public static int SIZE_PIXELS(Code) | | |
| VALIGN_BASELINE | | final public static String VALIGN_BASELINE(Code) | | |
| _baseSortColumn | | protected int _baseSortColumn(Code) | | |
| _baseSortDir | | protected int _baseSortDir(Code) | | |
| _border | | protected int _border(Code) | | |
| _bottomRightBorder | | protected Color _bottomRightBorder(Code) | | |
| _breakColumns | | protected int _breakColumns(Code) | | |
| _cacheKey | | protected long _cacheKey(Code) | | |
| _cellPadding | | protected int _cellPadding(Code) | | |
| _cellSpacing | | protected int _cellSpacing(Code) | | |
| _clickSort | | protected boolean _clickSort(Code) | | |
| _clickSortColumn | | protected int _clickSortColumn(Code) | | |
| _containerWidth | | protected int _containerWidth(Code) | | |
| _defaultHeadingBackground | | protected String _defaultHeadingBackground(Code) | | |
| _defaultRowBackground1 | | protected String _defaultRowBackground1(Code) | | |
| _defaultRowBackground2 | | protected String _defaultRowBackground2(Code) | | |
| _didSubmit | | protected boolean _didSubmit(Code) | | |
| _displayRowComponents | | protected boolean _displayRowComponents(Code) | | |
| _firstRowOnPage | | protected int _firstRowOnPage(Code) | | |
| _firstSubmitButton | | protected int _firstSubmitButton(Code) | | |
| _height | | protected int _height(Code) | | |
| _maxPageButtons | | protected int _maxPageButtons(Code) | | |
| _newFirstButton | | protected int _newFirstButton(Code) | | |
| _newRowsPerPage | | protected int _newRowsPerPage(Code) | | |
| _newStartRow | | protected int _newStartRow(Code) | | |
| _pageButtonType | | protected int _pageButtonType(Code) | | |
| _propertyExpressions | | protected Vector _propertyExpressions(Code) | | |
| _rowPerPageSel | | protected boolean _rowPerPageSel(Code) | | |
| _rowsPerPage | | protected int _rowsPerPage(Code) | | |
| _scroll | | protected boolean _scroll(Code) | | |
| _scrollOnSort | | protected boolean _scrollOnSort(Code) | | |
| _sizeOption | | protected int _sizeOption(Code) | | |
| _sortColumn | | protected int _sortColumn(Code) | | |
| _sortDir | | protected int _sortDir(Code) | | |
| _transparentColor | | protected Color _transparentColor(Code) | | |
| _useCache | | protected boolean _useCache(Code) | | |
| HtmlDataTable | | public HtmlDataTable(String name, DataStoreBuffer d, HtmlPage p)(Code) | | Constructs a new HTMLDataTable.
Parameters:
name - Each component on a page must have a unique name.
Parameters:
d - The DataStoreBuffer to get the data from.
Parameters:
p - The page that the table will be added to. |
| HtmlDataTable | | public HtmlDataTable(String name, DataStoreBuffer d, String theme, HtmlPage p)(Code) | | Constructs a new HTMLDataTable.
Parameters:
name - Each component on a page must have a unique name.
Parameters:
d - The DataStoreBuffer to get the data from.
Parameters:
theme - The theme to use for loading properties.
Parameters:
p - The page that the table will be added to. |
| add | | public void add(HtmlComponent comp)(Code) | | This method should not be used in this type of container. Instead use
setComponentAt().
|
| addBucket | | public void addBucket(String name, String heading, int type) throws Exception(Code) | | Creates a datastore bucket and corresponding display components for the
search and list boxes.
Parameters:
name - Name of bucket
Parameters:
heading - heading for search box and/or list box, or null
Parameters:
type - Type of datastore column, using DataStore.DATATYPE_* values |
| addBucket | | public void addBucket(String name, String heading, int type, 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:
heading - heading for search box and/or list box, or null
Parameters:
type - Type of datastore column, using DataStore.DATATYPE_* values
Parameters:
href - HREF to use in hotlink from this column in list box, elsenull.
Parameters:
format - Format used to display column in listbox (as in DataStore),else null. |
| addBucket | | public void addBucket(String name, String heading, int type, String href, String format, 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:
heading - heading for search box and/or list box, or null
Parameters:
type - Type of datastore column, using DataStore.DATATYPE_* values
Parameters:
href - HREF to use in hotlink from this column in list box, elsenull.
Parameters:
format - Format used to display column in listbox (as in DataStore),else null.
Parameters:
propList - HtmlTableCellProperties |
| addColumn | | public void addColumn(String table, String column, String heading, int type) 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:
heading - heading for search box and/or list box, or null
Parameters:
type - Type of datastore column, using DataStore.DATATYPE_* values |
| addColumn | | public void addColumn(String table, String column, String heading, int type, 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:
heading - heading for search box and/or list box, or null
Parameters:
type - Type of datastore column, using DataStore.DATATYPE_* values
Parameters:
href - HREF to use in hotlink from this column in list box, elsenull. |
| addColumn | | public void addColumn(String table, String column, String heading, int type, 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:
heading - heading for search box and/or list box, or null
Parameters:
type - Type of datastore column, using DataStore.DATATYPE_* values
Parameters:
href - HREF to use in hotlink from this column in list box, elsenull.
Parameters:
format - Format used to display column in listbox (as in DataStore),else null. |
| addColumn | | public void addColumn(String table, String column, String heading, int type, String href, String format, 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 willbe forced to "NULL_TABLE"
Parameters:
column - Name of column for datastore
Parameters:
heading - heading for search box and/or list box, or null
Parameters:
type - Type of datastore column, using DataStore.DATATYPE_* values
Parameters:
href - HREF to use in hotlink from this column in list box, elsenull.
Parameters:
format - Format used to display column in listbox (as in DataStore),else null.
Parameters:
propList - HtmlTableCellProperties |
| addColumn | | public void addColumn(String table, String column, String heading, int type, String href, String format, HtmlTableCellProperties propHeading, 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 willbe forced to "NULL_TABLE"
Parameters:
column - Name of column for datastore
Parameters:
heading - heading for search box and/or list box, or null
Parameters:
type - Type of datastore column, using DataStore.DATATYPE_* values
Parameters:
href - HREF to use in hotlink from this column in list box, elsenull.
Parameters:
format - Format used to display column in listbox (as in DataStore),else null.
Parameters:
propHeading - HtmlTableCellProperties
Parameters:
propList - HtmlTableCellProperties |
| addDisplay | | public void addDisplay(String fullColName, String heading, HtmlComponent component, HtmlTableCellProperties prop) throws Exception(Code) | | Adds a component to the List display.
Parameters:
fullColName - Datastore column name in form table.column
Parameters:
heading - DataTable Heading, or null
Parameters:
component - HtmlComponent The component to add
Parameters:
prop - HtmlTableCellProperties Table cell properties |
| addDisplay | | public void addDisplay(String fullColName, String heading, HtmlComponent component, HtmlTableCellProperties propHeading, HtmlTableCellProperties propComponent) throws Exception(Code) | | Adds a component to the List display.
Parameters:
fullColName - Datastore column name in form table.column
Parameters:
heading - DataTable Heading, or null
Parameters:
component - HtmlComponent The component to add
Parameters:
propHeading - HtmlTableCellProperties the table-cell properties for thecolumn heading
Parameters:
propComponent - HtmlTableCellProperties the table-cell properties for the listdata |
| addPropertyExpression | | public void addPropertyExpression(Object comp, String propertyName, DataStoreEvaluator expEval) throws NoSuchMethodException, DataStoreException(Code) | | This method will add a property expression to the HtmlDataTable. The
property expression will automatically set a property value on the
specified component with the results of the passed expression as each row
in the table is processed. This can be used for example to make a
component invisible or visible depending on the value in the datastore
for a particular row: ex:
addPropertyExpression(comp,"visible","bucket==1") will call the
setVisible method on the component comp passing the results of the
expression.
Parameters:
comp - The component to set the property for
Parameters:
propertyName - The name of the property to set. The component must have acorresponding setProperty method or this method will throw aNoSuchMethodException
Parameters:
expEval - DataStoreEvaluator The datastore evaluator that evaluates theexpression
exception:
java.lang.NoSuchMethodException - The exception description.
exception:
com.salmonllc.sql.DataStoreException - The exception description. |
| addPropertyExpression | | public void addPropertyExpression(Object comp, String propertyName, DataStoreExpression propExpression) throws NoSuchMethodException, DataStoreException(Code) | | This method will add a property expression to the HtmlDataTable. The
property expression will automatically set a property value on the
specified component with the results of the passed expression as each row
in the table is processed. This can be used for example to make a
component invisible or visible depending on the value in the datastore
for a particular row: ex:
addPropertyExpression(comp,"visible","bucket==1") will call the
setVisible method on the component comp passing the results of the
expression.
Parameters:
comp - The component to set the property for
Parameters:
propertyName - The name of the property to set. The component must have acorresponding setProperty method or this method will throw aNoSuchMethodException
Parameters:
propExpression - com.salmonllc.html.PropertyExpression The instance ofPropertyExpression 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, String expression) throws NoSuchMethodException, DataStoreException(Code) | | This method will add a property expression to the HtmlDataTable. The
property expression will automatically set a property value on the
specified component with the results of the passed expression as each row
in the table is processed. This can be used for example to make a
component invisible or visible depending on the value in the datastore
for a particular row: ex:
addPropertyExpression(comp,"visible","bucket==1") will call the
setVisible method on the component comp passing the results of the
expression.
Parameters:
comp - The component to set the property for
Parameters:
propertyName - The name of the property to set. The component must have acorresponding setProperty method or this method will throw aNoSuchMethodException
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. |
| clearPropertyExpressions | | public void clearPropertyExpressions()(Code) | | This method will remove all property expressions from the table.
|
| executeEvent | | public boolean executeEvent(int eventType) throws Exception(Code) | | |
| getAlign | | public String getAlign()(Code) | | Returns the alignment property for the table.
align Valid values are ALIGN_LEFT,ALIGN_CENTER,ALIGN_RIGHT andALIGN_NONE. |
| getBackgroundColor | | public String getBackgroundColor()(Code) | | Gets the background color for the table.
|
| getBorder | | public int getBorder()(Code) | | Gets the border thickness for the table.
|
| getCacheKey | | public long getCacheKey()(Code) | | |
| getCellPadding | | public int getCellPadding()(Code) | | Gets the cell padding for the table.
|
| getCellSpacing | | public int getCellSpacing()(Code) | | Gets the cell spacing for the table.
|
| getClickSort | | public boolean getClickSort()(Code) | | Returns true if heading components should be underline links that sort
the list.
|
| getColumnWidth | | public int getColumnWidth(int column)(Code) | | This method gets the minimum width for a particular column in the table
or -1 if the column width has not been set
|
| getComponents | | public Enumeration getComponents()(Code) | | This method returns all the elements in the container.
|
| getDataStoreBuffer | | public DataStoreBuffer getDataStoreBuffer()(Code) | | Returns the internal data store buffer used by the component.
|
| getDidSubmit | | public boolean getDidSubmit()(Code) | | This method returns true if the datatable did the last submit of the page
through a sort or clicking on a paging button.
|
| getFirstRowOnPage | | public int getFirstRowOnPage()(Code) | | This method gets the first row displayed on the current page.
|
| getFooterComponents | | protected Vector getFooterComponents()(Code) | | Gets a vector containing the components in the data table footer.
|
| getFooterComponentsSize | | public int getFooterComponentsSize()(Code) | | This method returns all the elements in the container.
|
| getGenImagesForPagingButtons | | public boolean getGenImagesForPagingButtons()(Code) | | Gets whether the or not paging buttons will be generated images or
regular submit buttons.
|
| getGenTHeadAndBody | | public boolean getGenTHeadAndBody()(Code) | | Returns true if the component will generate THEAD, TBODY andTFOOT tags around the sections of the table. |
| getHeadingComponentAt | | public HtmlComponent getHeadingComponentAt(int pos)(Code) | | This method returns the heading component at the specified position or
null if non is found.
|
| getHeadingComponentAt | | public HtmlComponent getHeadingComponentAt(String name)(Code) | | This method returns the heading component at that is the same as the name
specified or null if none is found.
|
| getHeadingComponents | | protected Vector getHeadingComponents()(Code) | | Gets a vector containing the components in the data table heading.
|
| getHeadingComponentsSize | | public int getHeadingComponentsSize()(Code) | | This method returns all the elements in the container.
|
| getHeadingStyleClassName | | public String getHeadingStyleClassName()(Code) | | the default style sheet class for heading rows |
| getLinkFont | | public String getLinkFont()(Code) | | This method returns the font that is being used for links created with
addColumn.
|
| getMaxPageButtons | | public int getMaxPageButtons()(Code) | | This method gets the maximum number of paging buttons to display.
|
| getPage | | public int getPage(int row)(Code) | | This method returns the page the row is on.
|
| getPageButtonType | | public int getPageButtonType()(Code) | | Gets the type of paging buttons for the data table. Valid Types are
PAGE_BUTTON_TYPE_SUBMIT, PAGE_BUTTON_TYPE_IMAGE, PAGE_BUTTON_TYPE_TEXT
|
| getPagingButtonBackgroundColor | | public Color getPagingButtonBackgroundColor()(Code) | | This method returns the background color of paging button images
|
| getPagingButtonBottomRightColor | | public Color getPagingButtonBottomRightColor()(Code) | | This method returns the bottom right border color of paging button images
|
| getPagingButtonDisplayStyle | | public String getPagingButtonDisplayStyle()(Code) | | This method gets the Display Style for a generated page button image.
Valid Values are PAGE_BUTTON_STYLE_RECTANGLE and PAGE_BUTTON_STYLE_OVAL
|
| getPagingButtonFont | | public Font getPagingButtonFont()(Code) | | This method returns the font used for page button images
|
| getPagingButtonHeight | | public int getPagingButtonHeight()(Code) | | This method returns the height used for page button images
|
| getPagingButtonTextColor | | public Color getPagingButtonTextColor()(Code) | | This method returns the text color of page button images
|
| getRepeatHeadingsAfterBreak | | public boolean getRepeatHeadingsAfterBreak()(Code) | | A true false value indicating whether the heading band should be
reprinted after a page break
|
| getRowComponentAt | | public HtmlComponent getRowComponentAt(int pos)(Code) | | This method returns the row component at the specified position or null
if non is found.
|
| getRowComponentAt | | public HtmlComponent getRowComponentAt(String name)(Code) | | This method returns the row component at that is the same as the name
specified or null if none is found.
|
| getRowComponents | | protected Vector getRowComponents()(Code) | | Gets a vector containing the components in a data table row.
|
| getRowComponentsSize | | public int getRowComponentsSize()(Code) | | This method returns all the elements in the container.
|
| getRowStyleClassName1 | | public String getRowStyleClassName1()(Code) | | the default style sheet class for table rows |
| getRowStyleClassName2 | | public String getRowStyleClassName2()(Code) | | the default style sheet class for table alternate rows |
| getRowsPerPage | | public int getRowsPerPage()(Code) | | This method gets the number of rows to display on one page of output. A
value <= 0 will indicate no limit to the number of rows displayed.
|
| getScrollAnchor | | public String getScrollAnchor()(Code) | | This method gets the anchor to scroll to when a paging button on the
table is clicked. Set it to null for the top of the table.
|
| getScrollOnClickSort | | public boolean getScrollOnClickSort()(Code) | | Gets whether the datastore will build scrolling javascript when the user
clicks on a column heading to sort or a paging button.
|
| getSelRowsPerPage | | public boolean getSelRowsPerPage()(Code) | | Returns true if rows per page selector is visible.
|
| getSizeOption | | public int getSizeOption()(Code) | | This method returns the size option for the table and each cell in it.
Valid return values are SIZE_PIXELS or SIZE_PERCENT.
|
| getSortColumn | | public int getSortColumn()(Code) | | This method returns the number of the last column that the user clicked
on to sort the list.
|
| getSortDirection | | public int getSortDirection()(Code) | | This method returns the direction of the sort set when the user last
clicked a column heading to sort the list. Valid values are
DataStoreBuffer.SORT_ASC or DataStoreBuffer.SORT_DES.
|
| getTableHeight | | public int getTableHeight()(Code) | | Returns the table height (used for tables withpageButtonType=PAGE_BUTTON_TYPE_SCROLLBAR). |
| getTheme | | public String getTheme()(Code) | | This method returns the property theme for the component.
|
| getUseCache | | public boolean getUseCache()(Code) | | If the image is dynamically generated, this method will indicate whether
or not the Objectstore should cache it.
|
| getUseLinksForPagingButtons | | public boolean getUseLinksForPagingButtons()(Code) | | Gets whether the or not paging buttons will be links or submit.
|
| getWidth | | public int getWidth()(Code) | | This method returns the width of the table.
|
| isRowOnPage | | public boolean isRowOnPage(int row)(Code) | | This method returns true if the specified row is on the current page.
|
| processPropertyExpressions | | protected void processPropertyExpressions(int row)(Code) | | |
| removeAll | | public void removeAll()(Code) | | Removes all the components from the DataTable
|
| removeRowComponent | | public void removeRowComponent(HtmlComponent comp)(Code) | | Removes an html component from the row container.
Parameters:
comp - The component to remove |
| reset | | public void reset()(Code) | | |
| resetControlBreakFooterComponents | | public void resetControlBreakFooterComponents()(Code) | | This method will remove all Control Break Footer Components from the
DataTable.
|
| resetControlBreakHeadingComponents | | public void resetControlBreakHeadingComponents()(Code) | | This method will remove all Control Break Heading Components from the
DataTable.
|
| resetFooterComponents | | public void resetFooterComponents()(Code) | | This method will remove all Footer Components from the DataTable.
|
| resetHeadingComponents | | public void resetHeadingComponents()(Code) | | This method will remove all Heading Components from the DataTable.
|
| resetRowComponents | | public void resetRowComponents()(Code) | | This method will remove all Row Components from the DataTable.
|
| setAlign | | public void setAlign(String align)(Code) | | Sets the alignment property for the table.
Parameters:
align - Valid values are ALIGN_LEFT,ALIGN_CENTER,ALIGN_RIGHT andALIGN_NONE. |
| setBackgroundColor | | public void setBackgroundColor(String value)(Code) | | Sets the background color for the table.
|
| setBaseClickSort | | public void setBaseClickSort(String column, int dir)(Code) | | This method will set the base click sort column for the datastore. This
column and direction will be appended to the sort column that the user
clicked on.
Parameters:
column - The column to sort on
Parameters:
dir - int DataStoreBuffer.SORT_ASC or DataStoreBuffer.SORT_DES |
| setBorder | | public void setBorder(int border)(Code) | | Sets the border width for the table.
|
| setBreakColumns | | public void setBreakColumns(int[] cols)(Code) | | Use this method to set the columns that the Data Table will control break
on.
Parameters:
cols - An array of column numbers to break on. |
| setBreakColumns | | public void setBreakColumns(String[] cols)(Code) | | Use this method to set the columns that the Data Table will control break
on.
Parameters:
cols - An array of column names to break on. |
| setBreakColumns | | public void setBreakColumns(int col)(Code) | | Use this method to set the columns that the Data Table will control break
on.
Parameters:
col - The column number to break on. |
| setBreakColumns | | public void setBreakColumns(String col)(Code) | | Use this method to set the columns that the Data Table will control break
on.
Parameters:
col - A column name to break on. |
| setCacheKey | | public void setCacheKey(long key)(Code) | | |
| setCellPadding | | public void setCellPadding(int value)(Code) | | Sets the cell padding for the table.
|
| setCellSpacing | | public void setCellSpacing(int value)(Code) | | Sets the cell spacing for the table.
|
| setClickSort | | public void setClickSort(boolean clickSort)(Code) | | Set to true if heading components should be underline links that sort the
list.
|
| setColumnWidth | | public void setColumnWidth(int column, int width)(Code) | | Sets the column width for a particular column in the table.
|
| setContMessage | | public void setContMessage(HtmlComponent comp)(Code) | | Use this method to set a continuation message for an HtmlDataTable with
Control Break Columns. The component will be set to visible only for
control break headings where the first row on the page is not the first
row in the group.
|
| setControlBreakFooterComponentAt | | public void setControlBreakFooterComponentAt(int column, HtmlComponent comp)(Code) | | Sets a control break footer component at a particular row position in the
table.
|
| setControlBreakFooterComponentAt | | public void setControlBreakFooterComponentAt(int column, HtmlComponent comp, HtmlTableCellProperties props)(Code) | | Sets a control break footer component at a particular column position in
the table. The cell in the table will use properties specified in the
props argument.
|
| setControlBreakFooterComponents | | public void setControlBreakFooterComponents(HtmlComponent comp)(Code) | | Sets all the control break footer components on a particular row in the
table. If you want to use HtmlTableCellProperties you will have to use
setControlBreakFooterComponentAt(int,HtmlComponent,HtmlTableCellProperties)
|
| setControlBreakFooterComponents | | public void setControlBreakFooterComponents(HtmlComponent comp, HtmlTableCellProperties props)(Code) | | Sets all the control break footer components on a particular row in the
table. If you want to use HtmlTableCellProperties pass an array of
HtmlTableCellProperties with the ones that do not need cell props it as
null.
|
| setControlBreakHeadingComponentAt | | public void setControlBreakHeadingComponentAt(int column, HtmlComponent comp)(Code) | | Sets a control break heading component at a particular row position in
the table.
|
| setControlBreakHeadingComponentAt | | public void setControlBreakHeadingComponentAt(int column, HtmlComponent comp, HtmlTableCellProperties props)(Code) | | Sets a control break heading component at a particular column position in
the table. The cell in the table will use properties specified in the
props argument.
|
| setControlBreakHeadingComponents | | public void setControlBreakHeadingComponents(HtmlComponent comp)(Code) | | Sets all the control break heading components on a particular row in the
table. If you want to use HtmlTableCellProperties you will have to use
setControlBreakHeadingComponentAt(int,HtmlComponent,HtmlTableCellProperties)
|
| setControlBreakHeadingComponents | | public void setControlBreakHeadingComponents(HtmlComponent comp, HtmlTableCellProperties props)(Code) | | Sets all the control break heading components on a particular row in the
table. If you want to use HtmlTableCellProperties pass an array of
HtmlTableCellProperties with the ones that do not need cell props it as
null.
|
| setDataStore | | public void setDataStore(DataStoreBuffer d)(Code) | | Sets the internal data store used by the component.
|
| setDisplayRowComponents | | public void setDisplayRowComponents(boolean display)(Code) | | Use this method if you don't want the datatable to display the band with
row components.
|
| setFirstRowOnPage | | public void setFirstRowOnPage(int firstRowOnPage)(Code) | | This method sets the first row displayed on the current page.
|
| setFooterComponentAt | | public void setFooterComponentAt(int column, HtmlComponent comp)(Code) | | Sets a footer component at a particular row position in the table.
|
| setFooterComponentAt | | public void setFooterComponentAt(int column, HtmlComponent comp, HtmlTableCellProperties props)(Code) | | Sets a footer component at a particular row position in the table. The
cell in the table will use properties specified in the props argument.
|
| setFooterComponents | | public void setFooterComponents(HtmlComponent comp)(Code) | | Sets all the footer components on a particular row in the table. If you
want to use HtmlTableCellProperties you will have to use
setFooterComponentAt(int,HtmlComponent,HtmlTableCellProperties)
|
| setFooterComponents | | public void setFooterComponents(HtmlComponent comp, HtmlTableCellProperties props)(Code) | | Sets all the footer components on a particular row in the table. If you
want to use HtmlTableCellProperties pass an array of
HtmlTableCellProperties with the ones that do not need cell props it as
null.
|
| setGenImagesForPagingButtons | | public void setGenImagesForPagingButtons(boolean gen)(Code) | | Sets whether the or not paging buttons will be generated images or
regular submit buttons.
|
| setGenTHeadAndBody | | public void setGenTHeadAndBody(boolean genTHeadAndBody)(Code) | | trueif the component will generate THEAD, TBODY and TFOOT tagsaround the sections of the table. |
| setHeadingBackgroundColor | | public void setHeadingBackgroundColor(String value)(Code) | | Sets the background color for the heading band
|
| setHeadingComponentAt | | public void setHeadingComponentAt(int column, HtmlComponent comp)(Code) | | Sets a heading component at a particular row position in the table.
|
| setHeadingComponentAt | | public void setHeadingComponentAt(int column, HtmlComponent comp, HtmlTableCellProperties props)(Code) | | Sets a heading component at a particular row position in the table. The
cell in the table will use properties specified in the props argument.
|
| setHeadingComponents | | public void setHeadingComponents(HtmlComponent comp)(Code) | | Sets all the heading components on a particular row in the table. If you
want to use HtmlTableCellProperties you wil have to use
setHeadingComponentAt(int,HtmlComponent,HtmlTableCellProperties)
|
| setHeadingComponents | | public void setHeadingComponents(HtmlComponent comp, HtmlTableCellProperties props)(Code) | | Sets all the heading components on a particular row in the table. If you
want to use HtmlTableCellProperties pass an array of
HtmlTableCellProperties with the ones that do not need cell props it as
null.
|
| setHeadingStyleClassName | | public void setHeadingStyleClassName(String string)(Code) | |
Parameters:
string - sets the default style sheet class for heading rows |
| setLinkFont | | public void setLinkFont(String font)(Code) | | This method set which font will be used for links created with addColumn.
|
| setMaxPageButtons | | public void setMaxPageButtons(int max)(Code) | | This method sets the maximum number of paging buttons to display.
|
| setPage | | public void setPage(int page)(Code) | | This method will scroll to the first row on the current selected page
|
| setPageBreak | | public void setPageBreak(boolean bAddPageBreak)(Code) | | Adds a page break to this table for printing purposes (IE 5 and up only).
|
| setPageBreakIndex | | public void setPageBreakIndex(int idx)(Code) | | add a page break style to the rows depening on the index Creation date:
(11/15/01 1:40:29 PM)
Parameters:
idx - int |
| setPageButtonType | | public void setPageButtonType(int type)(Code) | | Sets the type of paging buttons for the data table. Valid Types are
PAGE_BUTTON_TYPE_SUBMIT, PAGE_BUTTON_TYPE_IMAGE, PAGE_BUTTON_TYPE_TEXT,
PAGE_BUTTON_TYPE_SCROLLBAR
|
| setPageSelectRenderer | | public void setPageSelectRenderer(String r)(Code) | | Sets a new render to draw the HTML for the table page selector, given the
class name for the renderer
|
| setPagingButtonBackgroundColor | | public void setPagingButtonBackgroundColor(Color c)(Code) | | This method sets the background color for the page button generated image
|
| setPagingButtonBottomRightColor | | public void setPagingButtonBottomRightColor(Color c)(Code) | | This method sets the bottom and right border color for the page button
generated image
|
| setPagingButtonDisplayStyle | | public void setPagingButtonDisplayStyle(String style)(Code) | | This method sets the Display Style for a generated image button. Valid
Values are PAGE_BUTTON_STYLE_RECTANGLE and PAGE_BUTTON_STYLE_OVAL
|
| setPagingButtonFont | | public void setPagingButtonFont(Font f)(Code) | | This method sets the font used for dynamically generated page button
images.
|
| setPagingButtonHeight | | public void setPagingButtonHeight(int height)(Code) | | This method sets the height used for page button images
|
| setRepeatHeadingsAfterBreak | | public void setRepeatHeadingsAfterBreak(boolean repeatHeadingsAfterBreak)(Code) | | A true false value indicating whether the heading band should be
reprinted after a page break
|
| setRowBackgroundColor1 | | public void setRowBackgroundColor1(String value)(Code) | | Sets the background color for rows in the data table. Rows can alternate
in color and this one sets the second color.
|
| setRowBackgroundColor2 | | public void setRowBackgroundColor2(String value)(Code) | | Sets the background color for rows in the data table. Rows can alternate
in color and this one sets the second color.
|
| setRowComponentAt | | public void setRowComponentAt(int column, HtmlComponent comp)(Code) | | Sets a row component at a particular row position in the table.
|
| setRowComponentAt | | public void setRowComponentAt(int column, HtmlComponent comp, HtmlTableCellProperties props)(Code) | | Sets a row component at a particular row position in the table. The cell
in the table will use properties specified in the props argument.
|
| setRowComponents | | public void setRowComponents(HtmlComponent comp)(Code) | | Sets a row component at a particular row position in the table.
|
| setRowComponents | | public void setRowComponents(HtmlComponent comp, HtmlTableCellProperties props)(Code) | | Sets a row component at a particular row position in the table. If you
want to use HtmlTableCellProperties pass an array of
HtmlTableCellProperties with the ones that do not need cell props it as
null.
|
| setRowStyleClassName1 | | public void setRowStyleClassName1(String string)(Code) | |
Parameters:
string - sets the default style sheet class for table rows |
| setRowStyleClassName2 | | public void setRowStyleClassName2(String string)(Code) | |
Parameters:
string - sets the default style sheet class for table alternate rows |
| setRowsPerPage | | public void setRowsPerPage(int rowsPerPage)(Code) | | This method sets the number of rows to display on one page of output. A
value <= 0 will indicate no limit to the number of rows displayed.
|
| setRowsPerPageRenderer | | public void setRowsPerPageRenderer(String r)(Code) | | Sets a new render to draw the HTML for the rows per page selector
|
| setScrollAnchor | | public void setScrollAnchor(String anchor)(Code) | | This method sets the anchor to scroll to when a paging button on the
table is clicked. Set it to null for the top of the table.
|
| setScrollOnClickSort | | public void setScrollOnClickSort(boolean scroll)(Code) | | Sets whether the datastore will build scrolling javascript when the user
clicks on a column heading to sort or a paging button.
|
| setSelRowsPerPage | | public void setSelRowsPerPage(boolean sel)(Code) | | Sets whether rows per page selector is visible.
|
| setSizeOption | | public void setSizeOption(int option)(Code) | | This method sets the size option for the table and each cell in it. Valid
return values are SIZE_PIXELS or SIZE_PERCENT.
|
| setSummaryRowText | | public void setSummaryRowText(String summaryRowText)(Code) | | This method sets the size option for the table and each cell in it. Valid
return values are SIZE_PIXELS or SIZE_PERCENT.
|
| setTableHeight | | public void setTableHeight(int tableHeight)(Code) | |
Parameters:
Sets - the table height (used for tables withpageButtonType=PAGE_BUTTON_TYPE_SCROLLBAR). |
| setTheme | | public void setTheme(String theme)(Code) | | This method sets the property theme for the component.
Parameters:
theme - The theme to use. |
| setUseCache | | public void setUseCache(boolean useCache)(Code) | | If the image is dynamically generated, this method will indicate whether
or not the Objectstore should cache it.
|
| setUseLinksForPagingButtons | | public void setUseLinksForPagingButtons(boolean gen)(Code) | | Sets whether the or not paging buttons will be links or submit.
|
| setWidth | | public void setWidth(int width)(Code) | | This method sets the minimum width of the table in either pixels or
percent depending on size option.
|
| sortOnComponent | | protected void sortOnComponent(HtmlComponent comp, int colNo) throws Exception(Code) | | This method was created in VisualAge.
Parameters:
comp - com.salmonllc.html.HtmlComponent |
|
|