javax.rad.genui.control
Class UITable

java.lang.Object
  javax.rad.genui.UIResource<C>
      javax.rad.genui.UIComponent<C>
          javax.rad.genui.control.AbstractControllable<ITable>
              javax.rad.genui.control.UITable

All Implemented Interfaces:

IControl, IControllable, ITableControl, ITranslatable, ICellFormatable, INavigationControl, ITable, IComponent, IResource, INamedObject, ITranslator

public class UITable
extends AbstractControllable<ITable>
implements ITable

Platform and technology independent Table. It is designed for use with AWT, Swing, SWT, JSP, JSF, ... .

See Also:

JTable

Field Summary

Fields inherited from class javax.rad.genui.UIComponent

bTranslate, lLastTranslationModified, parent, popupMenu

Fields inherited from class javax.rad.genui.UIResource

uiResource

Fields inherited from interface javax.rad.ui.control.INavigationControl

NAVIGATION_CELL_AND_FOCUS, NAVIGATION_CELL_AND_ROW_AND_FOCUS, NAVIGATION_NONE, NAVIGATION_ROW_AND_FOCUS

Fields inherited from interface javax.rad.model.ui.IControllable

COMMAND_DELETE, COMMAND_DUPLICATE, COMMAND_EDIT, COMMAND_EXPORT, COMMAND_FIRST, COMMAND_INSERT, COMMAND_INSERT_SUB, COMMAND_LAST, COMMAND_NEXT, COMMAND_PREVIOUS, COMMAND_RESTORE, COMMAND_SEARCH

Constructor Summary

	UITable() Creates a new instance of UITable.
	UITable(IDataBook pDataBook) Creates a new instance of UITable with the given data book.
	UITable(IDataBook pDataBook, ColumnView pColumnView) Creates a new instance of UITable with the given data book and column view.
protected	UITable(ITable pTable) Creates a new instance of UITable with the given table.
protected	UITable(ITable pTable, IDataBook pDataBook, ColumnView pColumnView) Creates a new instance of UITable with the given table, data book and column view.

Method Summary

void	cancelEditing() Informs the GUI control, that the last edit should be canceled(restored) the correct value is in the DataBook.
protected java.lang.String	createComponentName() Creates a name for this UIComponent.
void	doEdit() Starts editing.
IDataBook	getActiveDataBook() Gets the controllable IDataBook for this IControllable.
ICellFormatter	getCellFormatter() Gets the ICellFormatter.
ColumnView	getColumnView() Returns the ColumnView displayed by this control.
IDataBook	getDataBook() Returns the DataBook displayed by this control.
int	getEnterNavigationMode() Gets the navigation mode for the ENTER key.
int	getMaxRowHeight() Gets the max row height for automatic calculation.
int	getMinRowHeight() Gets the min row height for automatic calculation.
int	getRowHeight() Gets the row height.
int	getTabNavigationMode() Gets the navigation mode for the TAB key.
boolean	isAutoResize() Gets true, if the ITable is in auto resize mode.
boolean	isEditable() Gets if editable or not.
boolean	isMouseEventOnSelectedCell() True, if the mouse event occured on current selected cell.
boolean	isShowFocusRect() Gets if showing the focus rect or not.
boolean	isShowGridLines() Gets if the horizontal lines or vertical lines are shown.
boolean	isShowHorizontalLines() Gets if showing the vertical lines or not.
boolean	isShowSelection() Gets if showing the selection or not.
boolean	isShowVerticalLines() Gets if showing the vertical lines or not.
boolean	isSortOnHeaderEnabled() Gets true, if it is possible sorting the data by clicking on the header.
boolean	isTableHeaderVisible() Gets the visibility of the table header.
void	notifyRepaint() The control need to check if the part is visible and then repaint the part.
void	saveEditing() Informs the GUI control, that the last edit should be set into the IDataBook or IDataRow.
void	setAutoResize(boolean pAutoResize) Sets true, if the ITable is in auto resize mode.
void	setCellFormatter(ICellFormatter pCellFormatter) Sets the ICellFormatter.
void	setCellFormatter(java.lang.Object pCellFormatter, java.lang.String pMethodName) Sets the cell formatter.
void	setColumnView(ColumnView pColumnView) Sets the ColumnView displayed by this control.
void	setDataBook(IDataBook pDataBook) Sets the DataBook displayed by this control.
void	setEditable(boolean pEditable) Sets if editable or not.
void	setEnterNavigationMode(int pNavigationMode) Sets the navigation mode for the ENTER key.
void	setMaxRowHeight(int pMaxRowHeight) Sets the max row height for automatic calculation.
void	setMinRowHeight(int pMinRowHeight) Sets the min row height for automatic calculation.
void	setRowHeight(int pRowHeight) Sets the row height.
void	setShowFocusRect(boolean pShowFocusRect) Sets if showing the focus rect or not.
void	setShowGridLines(boolean pShowVerticalLines) Sets if the horizontal lines or vertical lines are shown.
void	setShowHorizontalLines(boolean pShowHorizontalLines) Sets if showing the vertical lines or not.
void	setShowSelection(boolean pShowSelection) Sets if showing the selection or not.
void	setShowVerticalLines(boolean pShowVerticalLines) Sets if showing the vertical lines or not.
void	setSortOnHeaderEnabled(boolean pSortOnHeaderEnabled) Set true, if it should possible sorting the data by clicking on the header.
void	setTableHeaderVisible(boolean pTableHeaderVisible) Sets the visibility of the table header.
void	setTabNavigationMode(int pNavigationMode) Sets the navigation mode for the TAB key.
void	startEditing() Informs the GUI control, that the editor should be opened.
void	updateTranslation() Notification for updating the translation.

Methods inherited from class javax.rad.genui.control.AbstractControllable

addNotify, createCellFormatter, createNodeFormatter, doCommand, doDelete, doDuplicate, doExport, doFirst, doInsert, doInsertSub, doLast, doNext, doNotifyController, doPrevious, doRestore, doSearch, getController, isCommandEnabled, isDeleteEnabled, isDuplicateEnabled, isEditEnabled, isExportEnabled, isFirstEnabled, isInsertEnabled, isInsertSubEnabled, isLastEnabled, isNextEnabled, isPreviousEnabled, isRestoreEnabled, isSearchEnabled, removeNotify, setController

Methods inherited from class javax.rad.genui.UIComponent

beforeAddNotify, capture, createComponentNamePrefix, debug, doEventKey, doTriggerPopMenu, equals, error, eventComponentMoved, eventComponentResized, eventFocusGained, eventFocusLost, eventKey, eventKeyPressed, eventKeyReleased, eventKeyTyped, eventMouseClicked, eventMouseEntered, eventMouseExited, eventMousePressed, eventMouseReleased, getBackground, getBounds, getComponentUIResource, getCurrentTranslation, getCursor, getDefaultName, getEventSource, getExistingNames, getFactory, getFont, getForeground, getLocation, getLocationOffset, getLocationRelativeTo, getMaximumSize, getMinimumSize, getName, getParent, getPopupMenu, getPreferredSize, getResource, getRootName, getSize, getStyle, getTabIndex, getToolTipText, getTranslation, getUIComponent, hashCode, incrementNameIfExists, info, invokeAndWait, invokeAndWait, invokeInThread, invokeInThread, invokeLater, invokeLater, isBackgroundSet, isBeforeNotified, isCursorSet, isEnabled, isFocusable, isFontSet, isForegroundSet, isMaximumSizeSet, isMinimumSizeSet, isNotified, isPreferredSizeSet, isTranslationChanged, isTranslationEnabled, isVisible, requestFocus, setBackground, setBounds, setBounds, setCursor, setDefaultName, setEnabled, setEventSource, setFocusable, setFont, setForeground, setLocation, setLocation, setLocationRelativeTo, setMaximumSize, setMaximumSize, setMinimumSize, setMinimumSize, setName, setParent, setPopupMenu, setPreferredSize, setPreferredSize, setRootName, setSize, setSize, setStyle, setTabIndex, setToolTipText, setTranslation, setTranslationEnabled, setUIComponent, setVisible, translate

Methods inherited from class javax.rad.genui.UIResource

eventResourceChanged, eventResourceChanged, fireResourceChanged, getObject, getObjectNames, getUIResource, hasResourceHandler, putObject, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface javax.rad.ui.control.ITable

getTranslation, setTranslation

Methods inherited from interface javax.rad.ui.IComponent

capture, eventComponentMoved, eventComponentResized, eventFocusGained, eventFocusLost, eventKeyPressed, eventKeyReleased, eventKeyTyped, eventMouseClicked, eventMouseEntered, eventMouseExited, eventMousePressed, eventMouseReleased, getBackground, getBounds, getCursor, getEventSource, getFactory, getFont, getForeground, getLocation, getLocationRelativeTo, getMaximumSize, getMinimumSize, getName, getParent, getPreferredSize, getSize, getStyle, getTabIndex, getToolTipText, isBackgroundSet, isCursorSet, isEnabled, isFocusable, isFontSet, isForegroundSet, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isVisible, requestFocus, setBackground, setBounds, setCursor, setEnabled, setEventSource, setFocusable, setFont, setForeground, setLocation, setLocationRelativeTo, setMaximumSize, setMinimumSize, setName, setParent, setPreferredSize, setSize, setStyle, setTabIndex, setToolTipText, setVisible

Methods inherited from interface javax.rad.ui.IResource

getResource

Methods inherited from interface javax.rad.model.ui.ITranslatable

isTranslationEnabled, setTranslationEnabled

Methods inherited from interface javax.rad.util.ITranslator

translate

Constructor Detail

UITable

public UITable()

Creates a new instance of UITable.

See Also:

ITable

UITable

public UITable(IDataBook pDataBook)

Creates a new instance of UITable with the given data book.

Parameters:

pDataBook - the data book.

See Also:

setDataBook(IDataBook)

UITable

public UITable(IDataBook pDataBook,
               ColumnView pColumnView)

Creates a new instance of UITable with the given data book and column view.

Parameters:

pDataBook - the data book.

pColumnView - the column view.

See Also:

setDataBook(IDataBook), setColumnView(ColumnView)

UITable

protected UITable(ITable pTable)

Creates a new instance of UITable with the given table.

Parameters:

pTable - the table

See Also:

ITable

UITable

protected UITable(ITable pTable,
                  IDataBook pDataBook,
                  ColumnView pColumnView)

Creates a new instance of UITable with the given table, data book and column view.

Parameters:

pTable - the table.

pDataBook - the data book.

pColumnView - the column view.

See Also:

ITable, setDataBook(IDataBook), setColumnView(ColumnView)

Method Detail

getDataBook

public IDataBook getDataBook()

Returns the DataBook displayed by this control.

Specified by:

getDataBook in interface ITableControl

Returns:

the DataBook.

See Also:

ITableControl.setDataBook(javax.rad.model.IDataBook)

setDataBook

public void setDataBook(IDataBook pDataBook)

Sets the DataBook displayed by this control.

Specified by:

setDataBook in interface ITableControl

Parameters:

pDataBook - the DataBook

See Also:

ITableControl.getDataBook()

getActiveDataBook

public IDataBook getActiveDataBook()

Gets the controllable IDataBook for this IControllable. IEditorControl should return the set data row, if it is instanceof IDataBook or null otherwise. ITableControl should return the set data book. ITreeControl should return the data book of the current selected node. The controller has to be informed, If the databook changes on a focused IControllable. eg: ITreeControl node selection of a different databook. Editor or table has the focus, and a different databook is set on editor or table.

Specified by:

getActiveDataBook in interface IControllable

Returns:

the controllable IDataBook

getColumnView

public ColumnView getColumnView()

Returns the ColumnView displayed by this control. If null is set, the default ColumnView is shown.

Specified by:

getColumnView in interface ITable

Returns:

the ColumnView.

See Also:

ITable.setColumnView(javax.rad.model.ColumnView)

setColumnView

public void setColumnView(ColumnView pColumnView)

Sets the ColumnView displayed by this control. If null is set, the default ColumnView is shown.

Specified by:

setColumnView in interface ITable

Parameters:

pColumnView - the ColumnView

See Also:

ITable.getColumnView()

isAutoResize

public boolean isAutoResize()

Gets true, if the ITable is in auto resize mode.

Specified by:

isAutoResize in interface ITable

Returns:

true, if the ITable is in auto resize mode.

setAutoResize

public void setAutoResize(boolean pAutoResize)

Sets true, if the ITable is in auto resize mode.

Specified by:

setAutoResize in interface ITable

Parameters:

pAutoResize - true, if the ITable is in auto resize mode.

getMaxRowHeight

public int getMaxRowHeight()

Gets the max row height for automatic calculation.

Specified by:

getMaxRowHeight in interface ITable

Returns:

the max row height for automatic calculation.

getMinRowHeight

public int getMinRowHeight()

Gets the min row height for automatic calculation.

Specified by:

getMinRowHeight in interface ITable

Returns:

the min row height for automatic calculation.

getRowHeight

public int getRowHeight()

Gets the row height. A negativ row height means automatic calculation of row height between min and max row height. A positiv row height should be used as is.

Specified by:

getRowHeight in interface ITable

Returns:

the row height.

setMaxRowHeight

public void setMaxRowHeight(int pMaxRowHeight)

Sets the max row height for automatic calculation.

Specified by:

setMaxRowHeight in interface ITable

Parameters:

pMaxRowHeight - the max row height for automatic calculation.

setMinRowHeight

public void setMinRowHeight(int pMinRowHeight)

Sets the min row height for automatic calculation.

Specified by:

setMinRowHeight in interface ITable

Parameters:

pMinRowHeight - the min row height for automatic calculation.

setRowHeight

public void setRowHeight(int pRowHeight)

Sets the row height. A negativ row height means automatic calculation of row height between min and max row height. A positiv row height should be used as is.

Specified by:

setRowHeight in interface ITable

Parameters:

pRowHeight - the row height.

isTableHeaderVisible

public boolean isTableHeaderVisible()

Gets the visibility of the table header.

Specified by:

isTableHeaderVisible in interface ITable

Returns:

the visibility of the table header.

setTableHeaderVisible

public void setTableHeaderVisible(boolean pTableHeaderVisible)

Sets the visibility of the table header.

Specified by:

setTableHeaderVisible in interface ITable

Parameters:

pTableHeaderVisible - the visibility of the table header.

isSortOnHeaderEnabled

public boolean isSortOnHeaderEnabled()

Gets true, if it is possible sorting the data by clicking on the header.

Specified by:

isSortOnHeaderEnabled in interface ITable

Returns:

true, if it is possible sorting the data by clicking on the header.

setSortOnHeaderEnabled

public void setSortOnHeaderEnabled(boolean pSortOnHeaderEnabled)

Set true, if it should possible sorting the data by clicking on the header.

Specified by:

setSortOnHeaderEnabled in interface ITable

Parameters:

pSortOnHeaderEnabled - true, if it is possible sorting the data by clicking on the header.

getEnterNavigationMode

public int getEnterNavigationMode()

Gets the navigation mode for the ENTER key.

Specified by:

getEnterNavigationMode in interface INavigationControl

Returns:

the navigation mode for the ENTER key.

See Also:

INavigationControl.NAVIGATION_NONE, INavigationControl.NAVIGATION_CELL_AND_FOCUS, INavigationControl.NAVIGATION_CELL_AND_ROW_AND_FOCUS, INavigationControl.NAVIGATION_ROW_AND_FOCUS

getTabNavigationMode

public int getTabNavigationMode()

Gets the navigation mode for the TAB key.

Specified by:

getTabNavigationMode in interface INavigationControl

Returns:

the navigation mode for the TAB key.

See Also:

INavigationControl.NAVIGATION_NONE, INavigationControl.NAVIGATION_CELL_AND_FOCUS, INavigationControl.NAVIGATION_CELL_AND_ROW_AND_FOCUS, INavigationControl.NAVIGATION_ROW_AND_FOCUS

setEnterNavigationMode

public void setEnterNavigationMode(int pNavigationMode)

Sets the navigation mode for the ENTER key.

Specified by:

setEnterNavigationMode in interface INavigationControl

Parameters:

pNavigationMode - the navigation mode for the ENTER key.

See Also:

INavigationControl.NAVIGATION_NONE, INavigationControl.NAVIGATION_CELL_AND_FOCUS, INavigationControl.NAVIGATION_CELL_AND_ROW_AND_FOCUS, INavigationControl.NAVIGATION_ROW_AND_FOCUS

setTabNavigationMode

public void setTabNavigationMode(int pNavigationMode)

Sets the navigation mode for the TAB key.

Specified by:

setTabNavigationMode in interface INavigationControl

Parameters:

pNavigationMode - the navigation mode for the TAB key.

See Also:

INavigationControl.NAVIGATION_NONE, INavigationControl.NAVIGATION_CELL_AND_FOCUS, INavigationControl.NAVIGATION_CELL_AND_ROW_AND_FOCUS, INavigationControl.NAVIGATION_ROW_AND_FOCUS

notifyRepaint

public void notifyRepaint()

The control need to check if the part is visible and then repaint the part. Notify repaint is called on every change. The IControl has to catch the change, and return immediate. The change analysis and display has to be done with invoke later by the control.

Specified by:

notifyRepaint in interface IControl

startEditing

public void startEditing()

Informs the GUI control, that the editor should be opened.

Specified by:

startEditing in interface ITableControl

saveEditing

public void saveEditing()
                 throws ModelException

Informs the GUI control, that the last edit should be set into the IDataBook or IDataRow.

Specified by:

saveEditing in interface IControl

Throws:

ModelException - if the value can not be stored.

cancelEditing

public void cancelEditing()

Informs the GUI control, that the last edit should be canceled(restored) the correct value is in the DataBook.

Specified by:

cancelEditing in interface IControl

getCellFormatter

public ICellFormatter getCellFormatter()

Gets the ICellFormatter.

The ICellFormatter will be called for every cell and can return a style for that cell.

Specified by:

getCellFormatter in interface ICellFormatable

Returns:

the ICellFormatter.

See Also:

ICellFormatable.setCellFormatter(ICellFormatter)

setCellFormatter

public void setCellFormatter(ICellFormatter pCellFormatter)

Sets the ICellFormatter.

The ICellFormatter will be called for every cell and can return a style for that cell.

Specified by:

setCellFormatter in interface ICellFormatable

Parameters:

pCellFormatter - the ICellFormatter.

See Also:

ICellFormatable.getCellFormatter()

setCellFormatter

public void setCellFormatter(java.lang.Object pCellFormatter,
                             java.lang.String pMethodName)

Sets the cell formatter.

Parameters:

pCellFormatter - the cell formatter.

pMethodName - the method name.

isEditable

public boolean isEditable()

Gets if editable or not.

Specified by:

isEditable in interface ITable

Returns:

if editable or not.

setEditable

public void setEditable(boolean pEditable)

Sets if editable or not.

Specified by:

setEditable in interface ITable

Parameters:

pEditable - if editable or not.

isShowSelection

public boolean isShowSelection()

Gets if showing the selection or not.

Specified by:

isShowSelection in interface ITable

Returns:

showing the selection or not.

setShowSelection

public void setShowSelection(boolean pShowSelection)

Sets if showing the selection or not.

Specified by:

setShowSelection in interface ITable

Parameters:

pShowSelection - showing the selection or not.

isShowFocusRect

public boolean isShowFocusRect()

Gets if showing the focus rect or not.

Specified by:

isShowFocusRect in interface ITable

Returns:

showing the focus rect or not.

setShowFocusRect

public void setShowFocusRect(boolean pShowFocusRect)

Sets if showing the focus rect or not.

Specified by:

setShowFocusRect in interface ITable

Parameters:

pShowFocusRect - showing the focus rect or not.

isShowVerticalLines

public boolean isShowVerticalLines()

Gets if showing the vertical lines or not.

Specified by:

isShowVerticalLines in interface ITable

Returns:

showing the vertical lines or not.

setShowVerticalLines

public void setShowVerticalLines(boolean pShowVerticalLines)

Sets if showing the vertical lines or not.

Specified by:

setShowVerticalLines in interface ITable

Parameters:

pShowVerticalLines - showing the vertical lines or not.

isShowHorizontalLines

public boolean isShowHorizontalLines()

Gets if showing the vertical lines or not.

Specified by:

isShowHorizontalLines in interface ITable

Returns:

showing the vertical lines or not.

setShowHorizontalLines

public void setShowHorizontalLines(boolean pShowHorizontalLines)

Sets if showing the vertical lines or not.

Specified by:

setShowHorizontalLines in interface ITable

Parameters:

pShowHorizontalLines - showing the vertical lines or not.

isShowGridLines

public boolean isShowGridLines()

Gets if the horizontal lines or vertical lines are shown.

Returns:

true, the horizontal lines or vertical lines are shown.

setShowGridLines

public void setShowGridLines(boolean pShowVerticalLines)

Sets if the horizontal lines or vertical lines are shown.

Parameters:

pShowVerticalLines - true, the horizontal lines or vertical lines are shown.

isMouseEventOnSelectedCell

public boolean isMouseEventOnSelectedCell()

True, if the mouse event occured on current selected cell.

Specified by:

isMouseEventOnSelectedCell in interface ITable

Returns:

True, if the mouse event occured on current selected cell.

updateTranslation

public void updateTranslation()

Notification for updating the translation. This method will be called when the UIComponent will be added to a displayable containment hierarchy, when its containment hierarchy is made displayable or the translation table will be changed.

Overrides:

updateTranslation in class UIComponent<ITable>

See Also:

UIComponent.setTranslation(TranslationMap), UIComponent.addNotify()

createComponentName

protected java.lang.String createComponentName()

Creates a name for this UIComponent. The returned name needs to be unique in the current root/workscreen and is ideally, but not necessarily, prefixed with the UIComponent.sRootName, if there is any. Overriding classes should be aware that this method will be called in UIComponent.addNotify() and the returned name will only be assigned to the UIComponent if there isn't already a name set. Also UIComponent.stExistingNames can be used to find out if a name has already been assigned, and UIComponent.sRootName to get the root name. In rare cases UIComponent.stExistingNames and/or UIComponent.sRootName might be null when this method is called.

Overrides:

createComponentName in class UIComponent<ITable>

Returns:

a unique name for this UIComponent.

See Also:

UIComponent.getExistingNames(), UIComponent.getRootName(), UIComponent.incrementNameIfExists(String, Set, boolean)

doEdit

public void doEdit()

Starts editing.

Overrides:

doEdit in class AbstractControllable<ITable>