org.wingx
Class XTable

java.lang.Object
  org.wings.SComponent
      org.wings.STable
          org.wingx.XTable

All Implemented Interfaces:

Serializable, Cloneable, EventListener, CellEditorListener, TableModelListener, LowLevelEventListener, Renderable, Scrollable

public class XTable
extends STable

See Also:

Serialized Form

Nested Class Summary

static class

XTable.HeaderRenderer

Nested classes/interfaces inherited from class org.wings.STable

STable.TableColumnModelHandler

Field Summary

protected int	delayedSortColumn
protected boolean	filterVisible
static SIcon	ICON_REFRESH
static SIcon	ICON_RESET
protected boolean	resetFilter

Fields inherited from class org.wings.STable

cellEditor, cellEditorComponent, columnModel, defaultRenderer, editable, editingColumn, editingRow, editorComp, editors, epochCheckEnabled, fwdSelectionEvents, headerRenderer, headerVisible, intercellPadding, intercellSpacing, model, MULTIPLE_INTERVAL_SELECTION, MULTIPLE_SELECTION, NO_SELECTION, renderer, rowSelectionRenderer, selectable, selectionModel, SELECTOR_EVEN_ROWS, SELECTOR_HEADER, SELECTOR_ODD_ROWS, SELECTOR_SELECTED, showHorizontalLines, showVerticalLines, SINGLE_INTERVAL_SELECTION, SINGLE_SELECTION, tableColumnModelListener, viewport

Fields inherited from class org.wings.SComponent

DONE_RENDERING, dynamicStyles, enabled, propertyChangeSupport, SELECTOR_ALL, START_RENDERING, visible, WHEN_FOCUSED_OR_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_IN_FOCUSED_FRAME

Constructor Summary

XTable()

XTable(TableModel tableModel)

XTable(TableModel model, STableColumnModel columnModel)

Method Summary

void	addClickListener(int index, XTableClickListener listener)
protected STableColumnModel	createDefaultColumnModel() Returns the default column model object, which is a SDefaultTableColumnModel.
void	createDefaultColumnsFromModel() Creates the default columns of the table from the table model.
boolean	editCellAt(int row, int column, EventObject eo) Programmatically starts editing the cell at row and column, if the cell is editable.
protected boolean	filtersDifferent(Object filter, Object value)
void	fireFinalEvents() Internal event trigger used by CGs.
EditableTableCellRenderer	getFilterRenderer()
EditableTableCellRenderer	getFilterRenderer(int col) Returns the header renderer for the given header cell.
String	getNoDataAvailableLabel()
String	getNoDataFoundLabel()
String	getRefreshParameter()
String	getResetParameter()
String	getToggleSortParameter(int col)
boolean	isCellEditable(int row, int col) Returns true if the cell at row and column is editable.
boolean	isColumnSortable(int col)
boolean	isFilterVisible()
protected void	nameFilterComponent(SComponent component, int col)
protected void	nameFilterComponent(SComponent component, int col, int num)
SComponent	prepareFilterRenderer(EditableTableCellRenderer filterRenderer, int col) Prepares and returns the renderer to render the column filter
SComponent	prepareRenderer(STableCellRenderer r, int row, int col)
void	processLowLevelEvent(String action, String[] values) Deliver low level/http events (parameters).
void	refresh() refresh the table
void	removeClickListener(XTableClickListener listener)
void	resetFilter()
void	setFilterRenderer(EditableTableCellRenderer filterRenderer)
void	setFilterVisible(boolean filterVisible)
void	setNoDataAvailableLabel(String noDataAvailableLabel)
void	setNoDataFoundLabel(String noDataFoundLabel)
void	updateCG() Notification from the CGFactory that the L&F has changed.

Methods inherited from class org.wings.STable

addMouseListener, addRowSelectionInterval, addSelectionListener, addViewportChangeListener, clearSelection, columnAtPoint, convertColumnIndexToModel, convertColumnIndexToView, createDefaultDataModel, createDefaultEditors, createTableColumnModelListener, editCellAt, editingCanceled, editingStopped, fireIntermediateEvents, fireMouseClickedEvent, fireViewportChanged, getAutoCreateColumnsFromModel, getCellEditor, getCellEditor, getCellRenderer, getCellRendererPane, getColumnClass, getColumnCount, getColumnModel, getColumnName, getDefaultEditor, getDefaultRenderer, getDefaultRenderer, getDeselectionParameter, getEditingColumn, getEditingRow, getEditorComponent, getEditParameter, getHeaderBackground, getHeaderFont, getHeaderForeground, getHeaderRenderer, getHeaderRenderer, getIntercellPadding, getIntercellSpacing, getModel, getRowCount, getRowSelectionRenderer, getRowStyle, getScrollableViewportSize, getSelectedRow, getSelectedRowCount, getSelectedRows, getSelectionBackground, getSelectionFont, getSelectionForeground, getSelectionMode, getSelectionModel, getSelectionParameter, getShowHorizontalLines, getShowVerticalLines, getToggleSelectionParameter, getValueAt, getViewportSize, getVisibleColumnCount, isEditable, isEditing, isEpochCheckEnabled, isHeaderVisible, isRowSelected, isSelectable, nameEditorComponent, nameRendererComponent, prepareEditor, prepareHeaderRenderer, removeEditor, removeMouseListener, removeSelectionListener, removeViewportChangeListener, rowAtPoint, setAutoCreateColumnsFromModel, setCellEditor, setColumnModel, setDefaultEditor, setDefaultRenderer, setDefaultRenderer, setEditable, setEditingColumn, setEditingRow, setEpochCheckEnabled, setHeaderBackground, setHeaderFont, setHeaderForeground, setHeaderRenderer, setHeaderVisible, setIntercellPadding, setIntercellSpacing, setModel, setParent, setParentFrame, setRowSelectionRenderer, setSelectable, setSelectedRow, setSelectionBackground, setSelectionFont, setSelectionForeground, setSelectionMode, setSelectionModel, setShowGrid, setShowHorizontalLines, setShowVerticalLines, setValueAt, setViewportSize, tableChanged

Methods inherited from class org.wings.SComponent

addComponentListener, addDynamicStyle, addEventListener, addNotify, addParentFrameListener, addPropertyChangeListener, addPropertyChangeListener, addRenderListener, addScriptListener, addStyle, clone, fireComponentChangeEvent, fireKeyEvents, fireRenderEvent, getActionMap, getBackground, getBorder, getCG, getClientProperty, getComponentPopupMenu, getDynamicStyle, getDynamicStyles, getFocusTraversalIndex, getFont, getForeground, getHorizontalAlignment, getInputMap, getInputMap, getListenerCount, getListenerList, getListeners, getLowLevelEventId, getName, getParent, getParentFrame, getPreferredSize, getRequestURL, getResidesInForm, getScriptListenerList, getScriptListeners, getSession, getShowAsFormComponent, getStyle, getToolTipText, getVerticalAlignment, invite, isDifferent, isEnabled, isFocusOwner, isRecursivelyVisible, isReloadForced, isUpdatePossible, isVisible, paramString, processComponentEvent, processKeyEvents, putClientProperty, reload, reloadIfChange, reloadIfChange, reloadIfChange, reloadIfChange, reloadIfChange, reloadIfChange, reloadIfChange, reloadIfChange, reloadIfChange, removeComponentListener, removeDynamicStyle, removeEventListener, removeNotify, removeParentFrameListener, removePropertyChangeListener, removePropertyChangeListener, removeRenderListener, removeScriptListener, removeStyle, requestFocus, scrollRectToVisible, setActionMap, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttributes, setBackground, setBorder, setCG, setComponentPopupMenu, setDynamicStyles, setEnabled, setFocusTraversalIndex, setFont, setForeground, setHorizontalAlignment, setInputMap, setInputMap, setName, setNameRaw, setPreferredSize, setReloadForced, setShowAsFormComponent, setStyle, setToolTipText, setVerticalAlignment, setVisible, toString, update, write

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.wings.LowLevelEventListener

getLowLevelEventId, getName, isEnabled

Field Detail

ICON_REFRESH

public static final SIcon ICON_REFRESH

ICON_RESET

public static final SIcon ICON_RESET

filterVisible

protected boolean filterVisible

resetFilter

protected boolean resetFilter

delayedSortColumn

protected int delayedSortColumn

Constructor Detail

XTable

public XTable()

XTable

public XTable(TableModel model,
              STableColumnModel columnModel)

XTable

public XTable(TableModel tableModel)

Method Detail

getFilterRenderer

public EditableTableCellRenderer getFilterRenderer()

setFilterRenderer

public void setFilterRenderer(EditableTableCellRenderer filterRenderer)

nameFilterComponent

protected void nameFilterComponent(SComponent component,
                                   int col,
                                   int num)

filtersDifferent

protected boolean filtersDifferent(Object filter,
                                   Object value)

processLowLevelEvent

public void processLowLevelEvent(String action,
                                 String[] values)

Description copied from interface: LowLevelEventListener

Deliver low level/http events (parameters). The name-value-pairs of the HTTPRequest are considered low level events.

Specified by:

processLowLevelEvent in interface LowLevelEventListener

Overrides:

processLowLevelEvent in class STable

Parameters:

action - the name-value-pair's name

values - the name-value-pair's values

fireFinalEvents

public void fireFinalEvents()

Description copied from class: SComponent

Internal event trigger used by CGs. This Method is called internal and should not be called directly

Specified by:

fireFinalEvents in interface LowLevelEventListener

Overrides:

fireFinalEvents in class STable

refresh

public void refresh()

refresh the table

resetFilter

public void resetFilter()

updateCG

public void updateCG()

Description copied from class: SComponent

Notification from the CGFactory that the L&F has changed.

Overrides:

updateCG in class SComponent

See Also:

SComponent.updateCG()

getToggleSortParameter

public String getToggleSortParameter(int col)

getRefreshParameter

public String getRefreshParameter()

getResetParameter

public String getResetParameter()

getFilterRenderer

public EditableTableCellRenderer getFilterRenderer(int col)

Returns the header renderer for the given header cell.

Parameters:

col - Table column

Returns:

The header renderer for the given header cell.

prepareFilterRenderer

public SComponent prepareFilterRenderer(EditableTableCellRenderer filterRenderer,
                                        int col)

Prepares and returns the renderer to render the column filter

Parameters:

col - Column number to render. Starts with 0. May be -1 for row selection column.

Returns:

The renderer to render the column filter

nameFilterComponent

protected void nameFilterComponent(SComponent component,
                                   int col)

removeClickListener

public final void removeClickListener(XTableClickListener listener)

addClickListener

public void addClickListener(int index,
                             XTableClickListener listener)

isCellEditable

public boolean isCellEditable(int row,
                              int col)

Description copied from class: STable

Returns true if the cell at row and column is editable. Otherwise, setValueAt() on the cell will not change the value of that cell.

Overrides:

isCellEditable in class STable

Parameters:

row - the row whose value is to be looked up

col - the column whose value is to be looked up

Returns:

true if the cell is editable.

See Also:

STable.setValueAt(java.lang.Object, int, int)

isColumnSortable

public boolean isColumnSortable(int col)

isFilterVisible

public boolean isFilterVisible()

setFilterVisible

public void setFilterVisible(boolean filterVisible)

prepareRenderer

public SComponent prepareRenderer(STableCellRenderer r,
                                  int row,
                                  int col)

Overrides:

prepareRenderer in class STable

editCellAt

public boolean editCellAt(int row,
                          int column,
                          EventObject eo)

Description copied from class: STable

Programmatically starts editing the cell at row and column, if the cell is editable. To prevent the STable from editing a particular table, column or cell value, return false from the isCellEditable() method in the TableModel interface.

Overrides:

editCellAt in class STable

Parameters:

row - the row to be edited

column - the column to be edited

eo - event to pass into shouldSelectCell

Returns:

false if for any reason the cell cannot be edited.

createDefaultColumnsFromModel

public void createDefaultColumnsFromModel()

Description copied from class: STable

Creates the default columns of the table from the table model.

Overrides:

createDefaultColumnsFromModel in class STable

createDefaultColumnModel

protected STableColumnModel createDefaultColumnModel()

Description copied from class: STable

Returns the default column model object, which is a SDefaultTableColumnModel. A subclass can override this method to return a different column model object.

Overrides:

createDefaultColumnModel in class STable

Returns:

the default column model object

getNoDataFoundLabel

public String getNoDataFoundLabel()

setNoDataFoundLabel

public void setNoDataFoundLabel(String noDataFoundLabel)

getNoDataAvailableLabel

public String getNoDataAvailableLabel()

setNoDataAvailableLabel

public void setNoDataAvailableLabel(String noDataAvailableLabel)