Table ( @enterprise 10.0 API)

All Known Implementing Classes:

ConfiguredTable, TableAdapter
```
public interface Table
```
Interface describing a table for rendering in HTML

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class Table.ToolbarShape

Nested Classes
Modifier and Type	Interface and Description
`static class`	`Table.ToolbarShape`

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`SELECTION_HIDDEN` The first column is the oid or object, but the column is not shown: the column is only needed to find out the object for tablehandlers (linestyle, filter)
`static int`	`SELECTION_LINK` A link is used to select a row.
`static int`	`SELECTION_MULTIPLE` Show a checkbox for multiple selection of rows.
`static int`	`SELECTION_NONE` No selection of rows.
`static int`	`SELECTION_ROW_MULTIPLE` The line is clickable, multiple selections possible.
`static int`	`SELECTION_ROW_SINGLE` The line is clickable, only one line is selected.
`static int`	`SELECTION_SINGLE` Show a radio button for single selection of a row.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`List<ColumnDescription>`	`getColumns()` Return a list of column descriptions.
`String`	`getDefaultAction()` Returns the action that is executed on doubleclick on a row.
`String`	`getEditTarget()` The default target for toolbar functions
`String`	`getEditTargetProps()` Return the window properties for the edit target
`String`	`getEditUrl()` Returns an url used as link for toolbar functions
`String`	`getFieldName()` Return the name of the checkbox or radio buttons
`String`	`getFilterId()` Returns the id that is used when column filters are stored.
`String`	`getHelpContext()` Returns the context for online-help
`String`	`getId()` Returns the id of this table
`Page`	`getPage()` Define the page the table uses.
`int`	`getPagesize()` Return the size of a page (when using paging).
`List<String>`	`getSelectedItems()`
`int`	`getSelectionMode()` Return the mode for selection.
`int`	`getSortColumn()` Return the sort column.
`String`	`getTableFrameName()` Returns the name of the frame where the table resides.
`TableModel`	`getTableModel()` Builds the final tablemodel containing all data displayed in the table.
`int`	`getTableSize()` Determines the tablesize of the tablemodel without reading all the objects.
`Object`	`getTitle()` Return a string or Component for table title
`String`	`getToolbarActions()` Return a comma separated list of action ids for the toolbar.
`String`	`getToolbarFrameName()` Returns the name of the frame where the toolbar resides.
`Table.ToolbarShape`	`getToolbarShape()` Returns the desired mode of the toolbar.
`boolean`	`hasVerticalToolbar()` Returns true if the toolbar is vertical, false for horizontal.
`void`	`init(HttpServletRequest req)` Init the tablemodel (determine data to be displayed).
`boolean`	`isSortable()` Is the table sortable.
`String`	`lineStyle(int i, String style)` Use this method for defining a row specific css-class.
`boolean`	`oidOnly()` If true the value of the checkbox or radio button contains only the oid, otherwise it contains classname:oid
`void`	`setSearchString(String searchString)` Sets the search string for that table which may be used for filtering the table content
`boolean`	`showCounter()` Returns true if a counter is shown below the table.
`boolean`	`showToolbarIcons()` Deprecated. use getToolbarShape()
`boolean`	`sortAscending()` Is the table sorted ascending.
`boolean`	`useColumnPicker()` Returns true if column picker should be shown.
`boolean`	`useFilter()` Returns true if column filters are enabled.
`boolean`	`usePaging()` Returns true if paging is enabled.

- Field Detail
  - SELECTION_NONE
```
static final int SELECTION_NONE
```
    No selection of rows.
    
    See Also:
    
    Constant Field Values
  - SELECTION_LINK
```
static final int SELECTION_LINK
```
    A link is used to select a row. When the link is clicked the edit function of the table is called.
    
    See Also:
    
    Constant Field Values
  - SELECTION_SINGLE
```
static final int SELECTION_SINGLE
```
    Show a radio button for single selection of a row.
    
    See Also:
    
    Constant Field Values
  - SELECTION_MULTIPLE
```
static final int SELECTION_MULTIPLE
```
    Show a checkbox for multiple selection of rows.
    
    See Also:
    
    Constant Field Values
  - SELECTION_HIDDEN
```
static final int SELECTION_HIDDEN
```
    The first column is the oid or object, but the column is not shown: the column is only needed to find out the object for tablehandlers (linestyle, filter)
    
    See Also:
    
    Constant Field Values
  - SELECTION_ROW_SINGLE
```
static final int SELECTION_ROW_SINGLE
```
    The line is clickable, only one line is selected.
    
    See Also:
    
    Constant Field Values
  - SELECTION_ROW_MULTIPLE
```
static final int SELECTION_ROW_MULTIPLE
```
    The line is clickable, multiple selections possible.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - init
```
void init(HttpServletRequest req)
```
    Init the tablemodel (determine data to be displayed).
    
    Parameters:
    
    req -
  - setSearchString
```
void setSearchString(String searchString)
```
    Sets the search string for that table which may be used for filtering the table content
    
    Parameters:
    
    searchString - a string for filtering or null if no search string is defined
  - getTableSize
```
int getTableSize()
```
    Determines the tablesize of the tablemodel without reading all the objects.
    
    Returns:
    
    int representing the actual tablesize
  - getTableModel
```
TableModel getTableModel()
```
    Builds the final tablemodel containing all data displayed in the table.
    
    Returns:
    
    TableModel containing all the data
  - getTitle
```
Object getTitle()
```
    Return a string or Component for table title
  - getPage
```
Page getPage()
```
    Define the page the table uses. Has to return a new, empty page on each call.
  - isSortable
```
boolean isSortable()
```
    Is the table sortable.
  - sortAscending
```
boolean sortAscending()
```
    Is the table sorted ascending.
  - getSortColumn
```
int getSortColumn()
```
    Return the sort column.
  - getToolbarActions
```
String getToolbarActions()
```
    Return a comma separated list of action ids for the toolbar.
  - getTableFrameName
```
String getTableFrameName()
```
    Returns the name of the frame where the table resides.
  - getToolbarFrameName
```
String getToolbarFrameName()
```
    Returns the name of the frame where the toolbar resides.
  - hasVerticalToolbar
```
boolean hasVerticalToolbar()
```
    Returns true if the toolbar is vertical, false for horizontal.
  - showToolbarIcons
```
@Deprecated
boolean showToolbarIcons()
```
    Deprecated. use getToolbarShape()
    
    Returns true if the toolbar shows the icons, false for text toolbar.
  - getToolbarShape
```
Table.ToolbarShape getToolbarShape()
```
    Returns the desired mode of the toolbar.
  - lineStyle
```
String lineStyle(int i,
                 String style)
```
    Use this method for defining a row specific css-class.
    
    Parameters:
    
    i - the row index
    
    style - the css class that is set by the table renderer
    
    Returns:
    
    a css class
  - getSelectionMode
```
int getSelectionMode()
```
    Return the mode for selection.
    
    Returns:
    
    one of SELECTION_NONE, SELECTION_LINK, SELECTION_SINGLE, SELECTION_MULTIPLE, SELECTION_ROW_SINGLE, SELECTION_ROW_MULTIPLE
  - oidOnly
```
boolean oidOnly()
```
    If true the value of the checkbox or radio button contains only the oid, otherwise it contains classname:oid
  - getEditTarget
```
String getEditTarget()
```
    The default target for toolbar functions
  - getEditTargetProps
```
String getEditTargetProps()
```
    Return the window properties for the edit target
  - getFieldName
```
String getFieldName()
```
    Return the name of the checkbox or radio buttons
  - getEditUrl
```
String getEditUrl()
```
    Returns an url used as link for toolbar functions
  - getDefaultAction
```
String getDefaultAction()
```
    Returns the action that is executed on doubleclick on a row. See getToolbarActions() for a description of allowed values
  - useFilter
```
boolean useFilter()
```
    Returns true if column filters are enabled.
  - usePaging
```
boolean usePaging()
```
    Returns true if paging is enabled.
  - useColumnPicker
```
boolean useColumnPicker()
```
    Returns true if column picker should be shown.
  - getFilterId
```
String getFilterId()
```
    Returns the id that is used when column filters are stored. Normally this will be the id of the table, but if it is desired to use filters for several tables, another id can be defined.
  - showCounter
```
boolean showCounter()
```
    Returns true if a counter is shown below the table.
  - getColumns
```
List<ColumnDescription> getColumns()
```
    Return a list of column descriptions.
  - getId
```
String getId()
```
    Returns the id of this table
  - getSelectedItems
```
List<String> getSelectedItems()
```
  - getHelpContext
```
String getHelpContext()
```
    Returns the context for online-help
  - getPagesize
```
int getPagesize()
```
    Return the size of a page (when using paging).

Interface Table

Nested Class Summary

Field Summary

Method Summary

Field Detail

SELECTION_NONE

SELECTION_LINK

SELECTION_SINGLE

SELECTION_MULTIPLE

SELECTION_HIDDEN

SELECTION_ROW_SINGLE

SELECTION_ROW_MULTIPLE

Method Detail

init

setSearchString

getTableSize

getTableModel

getTitle

getPage

isSortable

sortAscending

getSortColumn

getToolbarActions

getTableFrameName

getToolbarFrameName

hasVerticalToolbar

showToolbarIcons

getToolbarShape

lineStyle

getSelectionMode

oidOnly

getEditTarget

getEditTargetProps

getFieldName

getEditUrl

getDefaultAction

useFilter

usePaging

useColumnPicker

getFilterId

showCounter

getColumns

getId

getSelectedItems

getHelpContext

getPagesize