org.vishia.gral.swt

Class SwtTable

java.lang.Object

org.vishia.gral.base.GralWidget.ImplAccess

org.vishia.gral.base.GralTable.GraphicImplAccess

org.vishia.gral.swt.SwtTable

All Implemented Interfaces:

GralWidgImplAccess_ifc

public class SwtTable
extends GralTable.GraphicImplAccess
implements GralWidgImplAccess_ifc

Implementation of the GralTable for Swt graphic. The following schema shows the aggregation relations, see org.vishia.util.Docu_UML_simpleNotation:

                      |--widgg----------------->GralWidget<|-------+
                      |                             |              |
            +--|>GralWidget.ImplAccess<--widgImpl---|              |
            |                                                      |
            |                                                      |
    +-|>GralTable.GraphicImplAccess                                |
    |                   |                                          |
 SwtTable               |                                     GralTable
    |                   |                                          |
    |                   |<-------------------------------------gi--|
    |                   |                                          |
    |                   |<&>-------------------------------------&>|
    |                        access to all protected methods and fields of GralTable
    |
    |
    |
    |---swtWidg----->SwtWidgetHelper
    |                       |
    |                       |
    |                       |--widgetSwt--->Control<|---Composite<|---SwtTable.Table
    |                                                      |               |
    |---cellsSwt--------------*>Text<*---------------------|            some Listener
    |
    |
 

• The GralTable contains some implementation-non-specific things, most of table structure.
• To access from this class to the GralTable, the inner class GralTable.GraphicImplAccess is used as super class of SwtTable with protected access.
• The GralTable knows this class via the interface GralWidgImplAccess_ifc in its superclass association GralWidget._wdgImpl.
• The GralTable knows this class via GralTable.gi association with the proper type.
• The GralTable.GraphicImplAccess defines some abstract methods which are implemented here.
• But some implementations of GralWidgImplAccess_ifc is found in SwtWidgetHelper. That are unique implementations, reuse it!
• Therefore for reused implementations this class delegates the interface to swtWidgHelper.
• The Swt widget core implementation is SwtTable.Table which is derived from org.eclipse.swt.widgets.Composite. That Composite contains some text fields which are the visible rows and columns of the table.
• The text fields are created as children of the swt.widgets.Composite but associated in this class: cellsSwt. Therefore this class can access the visible rows and columns directly, using as org.eclipse.swt.widgets.Text.
• The inner class SwtTable.Table is necessary only as implementor of GralWidgetGthreadSet_ifc. But that is an Deprecated interface. It is possible to replace it later with an simple instance of Composite.
• The content of the table itself is stored in an array of GralTable#tableLines, see description of GralTable.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) static class	SwtTable.ActionUserMenuItem This class wraps the GralUserAction for a menu action for the table.
private class	SwtTable.MousePressedListenerTable
(package private) class	SwtTable.MouseWheelListenerTable
(package private) static class	SwtTable.Table The SWT-Composite for the cell texts and the scroll bar.
(package private) class	SwtTable.TableKeyListerner A Table is completed with a special key listener.
private class	SwtTable.Vscrollbar The widget for the vertical scroll bar is a canvas with a special paint routine.
private class	SwtTable.XXXFocusListenerCell An instance of this is associated to any cell of the table.
private class	SwtTable.XXXFocusListenerTable Debug: this focus listener is not invoked any time.

Field Summary

Fields

Modifier and Type	Field and Description
private Text	cellInFocus
private Text[][]	cellsSwt Some SWT Text Control fields.
(package private) Color	colorBackVscrollbar
(package private) Color	colorSliderVscrollbar
(package private) FocusListener	focusListenerCells
private SwtTable.MousePressedListenerTable	mousePressedListener
private SwtTable.MouseWheelListenerTable	mouseWheelListener
private SwtTable.TableKeyListerner	myKeyListener
protected SwtKeyListener	swtKeyListener
protected Text	swtSearchText SWT Text Control which contains a search text.
private SwtWidgetHelper	swtWidgHelper It contains the association to the swt widget (Control) and the SwtMng and implements some methods of GralWidgImplAccess_ifc which are delegate from this.
(package private) TraverseListener	traverseListenerTable
static java.lang.String	version Version and history 2018-01-07 Hartmut new: getCellTextFocus() 2015-08-29 Hartmut chg: It has a traverseListenerTable now to accept 'tab' and 'sh-tab' as normal key instead usage to traverse between the text fields of a table.
private Canvas	vScrollBar
(package private) ControlListener	XXXresizeListener The Resize listener for the whole table (a swt.Composite).

Fields inherited from class org.vishia.gral.base.GralTable.GraphicImplAccess

bFocused, bFocusLost, bRedrawPending, bVscrollbarChanged, cells, chgEditableColumn, ixColorScrollbar, ixColorScrollbarLast, ixColumnFocus, ixLineFocus, linePixel, mousect, mousetime, nrofColumnTreeShift, outer, redrawct, redrawtime, xpixelCell, xPixelUnit, XXXhasFocus, xyVscrollbar, y1Scrollbar, y2Scrollbar

Fields inherited from class org.vishia.gral.base.GralWidget.ImplAccess

bRedrawOnlyDynamics, chgBitsDerived, chgColorBack, chgColorLine, chgColorText, chgCurrTab, chgEditable, chgFloat, chgFocus, chgFont, chgIntg, chgInvisible, chgObjects, chgPos, chgText, chgVisible, chgVisibleInfo, mngImpl, pixBounds, wdgimpl, widgg

Constructor Summary

Constructors

Constructor and Description
SwtTable(GralTable<?> gralTable, SwtMng mng, Composite parent)

Method Summary

Modifier and Type	Method and Description
static GralTable	addTable(GralTable gralTable, SwtMng mng, java.lang.String sName, int height, int[] columnWidths) Deprecated. Create an instance of GralTable and call
protected GralMenu	createColumnMenu(int column) Should be implemented by the implementation class.
(package private) static GralWidget.ImplAccess	createTable(GralTable<?> gralTable, SwtMng mng)
protected void	drawCellContent(int iCellLine, GralTable.CellData[] cellLine, GralTable.TableLineData line, GralTable.LinePresentation linePresentationP) This routine implements all things to set the content of any table cell to show it.
protected GralTable.CellData	drawCellInvisible(int iCellLine, int iCellCol)
protected java.lang.String	getCellText(GralTable.CellData cell) Gets the current text of the given cell from the graphic implementation.
protected java.lang.String	getCellTextFocus() Gets the cell text from the focused cell in the implementation.
GralRectangle	getPixelPositionSize()
protected int	getVisibleLinesTableImpl()
java.lang.Object	getWidgetImplementation() Returns the implementation class of the widget.
protected void	initSwtTable(Composite swtTable, int zColumns, SwtMng mng, GralMenu contextMenu, GralMenu[] contextMenuColumn) It creates Text for each cell of the table, and assigns the swtKeyListener, focusListenerCells, mousePressedListener, mouseWheelListener, traverseListenerTable to all cells.
protected void	keyPressed(KeyEvent keyEv)
protected void	mouseDouble(MouseEvent ev) Called internal from mouse event only.
protected void	mouseDown(MouseEvent ev) Called internal from mouse event only.
protected void	mouseUp(MouseEvent ev) Called internal from mouse event only.
private void	paintVscrollbar(GC gc, Canvas canvas)
void	redrawGthread() TODO implement in GralTable.GraphicImplAccess
private void	redrawTableWithFocusedCell(Widget cell) Sets the current cell as focused with the focus color.
boolean	remove()
void	removeWidgetImplementation() Removes the graphical widgets.
GralColor	setBackgroundColor(GralColor color)
protected void	setBoundsCells(int treeDepthBase, int zLineVisible) Invoked in GralTable.GraphicImplAccess.resizeTable(GralRectangle) as action which should be implemented in the implementation layer.
void	setBoundsPixel(int x, int y, int dx, int dy) Set the bounds of the implementation widget.
private void	setColorsSwt()
protected void	setDragEnable(int dragType) Implementation routine to set receiving a drag event and initializes the drag feature of the widget.
boolean	setFocusGThread() Sets the focus to the current cell of the tab
GralColor	setForegroundColor(GralColor color)
(package private) void	setTextToLine(Text widgSwt) Invoked on swtKeyListener if enter.
void	setVisibleGThread(boolean bVisible) Sets the implementation widget(s) visible state.
(package private) void	stop()
void	updateValuesForAction() This operation should be called before any action is invoked in the user space.

Methods inherited from class org.vishia.gral.base.GralTable.GraphicImplAccess

bChangedLinesForCell, bChangedLinesForCell, bColumnEditable, checkAndUpdateText, colorBackTable, colorBackVscrollbar, colorLineVscrollbar, colorSelectChars, colorSelectCharsBack, columnWidthsGral, columnWidthsPromille, determineSizeAndPositionScrollbar, focusGainedTable, focusLostTable, getContextMenuColumns, itsMng, ixColumn, mouseDoubleGral, mouseDownGral, mouseUpGral, processKeys, resizeTable, searchChars, setCellText, setFocusCellMousePressed, updateGraphicCellContent, zColumn

Methods inherited from class org.vishia.gral.base.GralWidget.ImplAccess

acknChanged, actionShow, dyda, getActionChange, getChanged, gralMng, gralWidgetFromImplData, redrawOnlyDynamics, setDropEnable, setPosBounds, setTextChanged, setVisibleState, XXXfocusGained

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.vishia.gral.base.GralWidgImplAccess_ifc

setPosBounds

Field Detail

version

public static final java.lang.String version

Version and history

• 2018-01-07 Hartmut new: getCellTextFocus()
• 2015-08-29 Hartmut chg: It has a traverseListenerTable now to accept 'tab' and 'sh-tab' as normal key instead usage to traverse between the text fields of a table. TODO: What traversing functions are missing yet? They should not any traverse function between the cells.
• 2013-06-29 Hartmut chg: refactoring. Now a GralTable can be created before the graphic is build. It is the new schema of GralWidget. The inner class GraphicImplAccess is provided as super class for the graphic implementation class, for example SwtTable.
• 2013-10-08 Hartmut chg:
• 2012-07-15 Hartmut new: search functionality: This implementation have a text field which shows the search string. While up and down keys the that lines are selected which text in the GralTable.GraphicImplAccess.ixColumn() starts whith the search string.
• 2012-01-06 Hartmut new: concept of a table which is independent of the table implementation of the table implementations in the graphic system layer or in operation system: The capability of a SWT-table is not sufficient, for example the color of the selection bar is not able to change. Other reason: Implementation of table in SWT, AWT, Swing is different. It seems better to have one table concept with independent features, which based on simple widgets. is not

Copyright/Copyleft: For this source the LGPL Lesser General Public License, published by the Free Software Foundation is valid. It means:

1. You can use this source without any restriction for any desired purpose.
2. You can redistribute copies of this source to everybody.
3. Every user of this source, also the user of redistribute copies with or without payment, must accept this license for further using.
4. But the LPGL ist not appropriate for a whole software product, if this source is only a part of them. It means, the user must publish this part of source, but don't need to publish the whole source of the own product.
5. You can study and modify (improve) this source for own using or for redistribution, but you have to license the modified sources likewise under this LGPL Lesser General Public License. You mustn't delete this Copyright/Copyleft inscription in this source file.

If you are intent to use this sources without publishing its usage, you can get a second license subscribing a special contract with the author.

See Also:

Constant Field Values

swtWidgHelper

private final SwtWidgetHelper swtWidgHelper

It contains the association to the swt widget (Control) and the SwtMng and implements some methods of GralWidgImplAccess_ifc which are delegate from this.

cellsSwt

private final Text[][] cellsSwt

Some SWT Text Control fields. There are the visible cells of the table. They are children of the Composite in SwtWidgetHelper.widgetSwt.

vScrollBar

private Canvas vScrollBar

cellInFocus

private Text cellInFocus

colorBackVscrollbar

Color colorBackVscrollbar

colorSliderVscrollbar

Color colorSliderVscrollbar

swtSearchText

protected Text swtSearchText

SWT Text Control which contains a search text. It is only visible if need.

mousePressedListener

private final SwtTable.MousePressedListenerTable mousePressedListener

mouseWheelListener

private final SwtTable.MouseWheelListenerTable mouseWheelListener

myKeyListener

private final SwtTable.TableKeyListerner myKeyListener

focusListenerCells

FocusListener focusListenerCells

XXXresizeListener

ControlListener XXXresizeListener

The Resize listener for the whole table (a swt.Composite). The controlResized(...) operation calls GralTable.GraphicImplAccess.resizeTable(GralRectangle) which calculates and sets the bounds of all swt.Text fields.

traverseListenerTable

TraverseListener traverseListenerTable

swtKeyListener

protected SwtKeyListener swtKeyListener

Constructor Detail

SwtTable

public SwtTable(GralTable<?> gralTable,
                SwtMng mng,
                Composite parent)

Method Detail

addTable

@Deprecated
public static GralTable addTable(GralTable gralTable,
                                              SwtMng mng,
                                              java.lang.String sName,
                                              int height,
                                              int[] columnWidths)

Deprecated. Create an instance of GralTable and call

Parameters:

gralTable -

mng -

sName -

height -

columnWidths -

Returns:

createTable

static GralWidget.ImplAccess createTable(GralTable<?> gralTable,
                                         SwtMng mng)

setColorsSwt

private void setColorsSwt()

getWidgetImplementation

public java.lang.Object getWidgetImplementation()

Description copied from interface: GralWidgImplAccess_ifc

Returns the implementation class of the widget. If the widget has more as one implementation widgets, this method returns one of the widgets, usual the first important one respectively that widget which represents the implementation layer. A widget of the implementation layer is a SWT.control or a Component.

If more as one widget are part of the GralWidget, use the special GralWidget._wdgImpl class which should contain the references to that implementation widgets.

Specified by:

getWidgetImplementation in interface GralWidgImplAccess_ifc

Overrides:

getWidgetImplementation in class GralWidget.ImplAccess

setBackgroundColor

public GralColor setBackgroundColor(GralColor color)

setForegroundColor

public GralColor setForegroundColor(GralColor color)

setBoundsPixel

public void setBoundsPixel(int x,
                           int y,
                           int dx,
                           int dy)

Description copied from interface: GralWidgImplAccess_ifc

Set the bounds of the implementation widget. This is called especially on resize from the panel, but also on creation for comprehensive widgets. If the widget is more comprehensive, consist of more basic widgets, then this operation should care about the parts of the widget.

Specified by:

setBoundsPixel in interface GralWidgImplAccess_ifc

getPixelPositionSize

public GralRectangle getPixelPositionSize()

Specified by:

getPixelPositionSize in interface GralWidgImplAccess_ifc

redrawGthread

public void redrawGthread()

TODO implement in GralTable.GraphicImplAccess

Specified by:

redrawGthread in interface GralWidgImplAccess_ifc

See Also:

GralWidgImplAccess_ifc.redrawGthread()

setFocusGThread

public boolean setFocusGThread()

Sets the focus to the current cell of the tab

Specified by:

setFocusGThread in interface GralWidgImplAccess_ifc

Returns:

true if it has the focus after this operation. false on any error.

See Also:

TODO this method must call in the graphic thread yet, queue it with {@link GralMng#setInfo(GralWidget, int, int, Object, Object)}.

setVisibleGThread

public void setVisibleGThread(boolean bVisible)

Description copied from interface: GralWidgImplAccess_ifc

Sets the implementation widget(s) visible state. The widgets are really invisible, or they are visible in principle, but they can be covered by other windows or clipping. This method should set the GralWidgetBase.bVisibleState too. Therewith it is able to quest GralWidget.isVisible() in any thread.

Specified by:

setVisibleGThread in interface GralWidgImplAccess_ifc

Parameters:

bVisible - true then the widget should be visible, false it is set to invisible.

setDragEnable

protected void setDragEnable(int dragType)

Description copied from class: GralWidget.ImplAccess

Implementation routine to set receiving a drag event and initializes the drag feature of the widget. A overridden routine should be implemented for the implementation graphic layer widget. This routine is invoked when it isn't overridden, it throws an exception because the drag feature isn't supported for the implementation.

Overrides:

setDragEnable in class GralWidget.ImplAccess

Parameters:

dragType - one of org.vishia.util.KeyCode#dragFiles or ..dragText

removeWidgetImplementation

public void removeWidgetImplementation()

Removes the graphical widgets.

Specified by:

removeWidgetImplementation in interface GralWidgImplAccess_ifc

See Also:

org.vishia.gral.base.GralWidget#removeWidgetImplementation()

remove

public boolean remove()

Overrides:

remove in class GralTable.GraphicImplAccess

redrawTableWithFocusedCell

private void redrawTableWithFocusedCell(Widget cell)

Sets the current cell as focused with the focus color. It causes a redraw of the whole table because the cell may be shifted in table position. TODO this method must call in the graphic thread yet, queue it with GralMng#setInfo(GralWidget, int, int, Object, Object).

Parameters:

cell - The cell

getVisibleLinesTableImpl

protected int getVisibleLinesTableImpl()

Specified by:

getVisibleLinesTableImpl in class GralTable.GraphicImplAccess

drawCellContent

protected void drawCellContent(int iCellLine,
                               GralTable.CellData[] cellLine,
                               GralTable.TableLineData line,
                               GralTable.LinePresentation linePresentationP)

This routine implements all things to set the content of any table cell to show it.

Specified by:

drawCellContent in class GralTable.GraphicImplAccess

Parameters:

iCellLine - index in the line (visible Text fields)

cellData - data for the Text[] of this line: color, etc. see GralTable.CellData

line - the line in the container of the table. Note: it is a node structure

linePresentationP - colors of the line

See Also:

org.vishia.gral.base.GralTable#drawCellContent(int, int, org.vishia.gral.base.GralTable.TableLineData)

drawCellInvisible

protected GralTable.CellData drawCellInvisible(int iCellLine,
                                               int iCellCol)

Specified by:

drawCellInvisible in class GralTable.GraphicImplAccess

paintVscrollbar

private void paintVscrollbar(GC gc,
                             Canvas canvas)

createColumnMenu

protected GralMenu createColumnMenu(int column)

Description copied from class: GralTable.GraphicImplAccess

Should be implemented by the implementation class.

Specified by:

createColumnMenu in class GralTable.GraphicImplAccess

Parameters:

column - The column

Returns:

The menu.

mouseDown

protected void mouseDown(MouseEvent ev)

Called internal from mouse event only.

Parameters:

ev -

mouseUp

protected void mouseUp(MouseEvent ev)

Called internal from mouse event only.

Parameters:

ev -

mouseDouble

protected void mouseDouble(MouseEvent ev)

Called internal from mouse event only.

Parameters:

ev -

setBoundsCells

protected void setBoundsCells(int treeDepthBase,
                              int zLineVisible)

Description copied from class: GralTable.GraphicImplAccess

Invoked in GralTable.GraphicImplAccess.resizeTable(GralRectangle) as action which should be implemented in the implementation layer. The GralTable.GraphicImplAccess.xpixelCell was set before.

Specified by:

setBoundsCells in class GralTable.GraphicImplAccess

setTextToLine

void setTextToLine(Text widgSwt)

Invoked on swtKeyListener if enter.

getCellText

protected java.lang.String getCellText(GralTable.CellData cell)

Description copied from class: GralTable.GraphicImplAccess

Gets the current text of the given cell from the graphic implementation.

Specified by:

getCellText in class GralTable.GraphicImplAccess

Returns:

getCellTextFocus

protected java.lang.String getCellTextFocus()

Description copied from class: GralTable.GraphicImplAccess

Gets the cell text from the focused cell in the implementation.

Specified by:

getCellTextFocus in class GralTable.GraphicImplAccess

initSwtTable

protected void initSwtTable(Composite swtTable,
                            int zColumns,
                            SwtMng mng,
                            GralMenu contextMenu,
                            GralMenu[] contextMenuColumn)

It creates Text for each cell of the table, and assigns the swtKeyListener, focusListenerCells, mousePressedListener, mouseWheelListener, traverseListenerTable to all cells.
Each cell gets GralTable.CellData as Control#setData(Object).

Parameters:

swtTable -

zColumns -

mng -

keyPressed

protected void keyPressed(KeyEvent keyEv)

stop

void stop()

updateValuesForAction

public void updateValuesForAction()

Description copied from interface: GralWidgImplAccess_ifc

This operation should be called before any action is invoked in the user space. It should update all values from the implementation widget to the GralWidget to enable getting it in the action.

Specified by:

updateValuesForAction in interface GralWidgImplAccess_ifc