org.vishia.gral.widget

Class GralSelectList<UserData>

java.lang.Object

org.vishia.gral.base.GralWidgetBase

org.vishia.gral.widget.GralSelectList<UserData>

All Implemented Interfaces:

GralWidgetBase_ifc

Direct Known Subclasses:

FcmdLeftMidRightPanel.FcmdFavorThemeCard, GralCommandSelector, GralFileSelector.FileSelectList

public abstract class GralSelectList<UserData>
extends GralWidgetBase

The base class for lists which supports nested selections. The associated widget is a table. The action listener actionTable captures all key and mouse activities on the table-widget. It is the base class for file selection and command selection. The base idea is, left and right keys navigates in a tree to outer and deeper nodes. The table shows only members of the current node. A text line shows the current node path. It may be possible to switch to a tree presentation (TODO). But this complex widget should occupy only a simple rectangle of a GUI, not some windows etc. It may be less in spread too if necessary.

Note: this class should not be a derived class of GralTable, because instances of derived classes should be created as final compositions in the main thread before the table can be presented in the graphic thread. Therefore the aggregation wdgdTable cannot be final. It is set only when #setToPanel(GralMngBuild_ifc, String, int, int[], char) is called.

  GralSelectList
        |--wdgdTable--->GralTable         TableLineData
                                     |---idxLine------*>|
                                     |---tableLines---*>|
 

Hint: The GralSelectList should not be inherited from GralTable though it seems to be possible, because it is not primary a table. It is more obvious to break the inheritance.

Nested Class Summary

Nested classes/interfaces inherited from class org.vishia.gral.base.GralWidgetBase

GralWidgetBase.GralWidgComposite, GralWidgetBase.TimeOrderCreateImplWidget

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,GralUserAction>	actions Not used yet, register actions?
private GralUserAction	actionTable This is the enhancement to key handling of a common table.
protected int	keyLeft The keys for left and right navigation.
protected int	keyLeft2 The keys for left and right navigation.
protected int	keyRight The keys for left and right navigation.
protected int	keyRight2 The keys for left and right navigation.
static java.lang.String	version Version and history: 2023-02-15 Hartmut new: second key set for entry/exit to left/right setLeftRightKeys(int, int, int, int) 2022-12-11 Hartmut chg: because new concept of Gral setToPanel is no more called.
GralTable<UserData>	wdgdTable The table which is showing in the widget.

Fields inherited from class org.vishia.gral.base.GralWidgetBase

_cdata, _wdgPos, bVisibleState, gralMng, name, pixSize, sVersion

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GralSelectList(GralPos refPos, java.lang.String posName, int rows, int[] columns)

Method Summary

Modifier and Type	Method and Description
protected abstract void	actionLeft(java.lang.Object userData, GralTableLine_ifc<UserData> line) Action if a table line is selected and ctrl-left is pressed or the release button is pressed.
protected abstract boolean	actionOk(java.lang.Object userData, GralTableLine_ifc<UserData> line) Action if a table line is selected and entered.
protected abstract void	actionRight(java.lang.Object userData, GralTableLine_ifc<UserData> line) Action if a table line is selected and ctrl-right is pressed or the release button is pressed.
protected abstract boolean	actionUserKey(int key, java.lang.Object userData, GralTableLine_ifc<UserData> line) Action if a table line is selected and any other key is pressed or the context menu is invoked.
boolean	createImplWidget_Gthread() This operation is called to create the implementation widget appearance.
GralWidgetBase_ifc	getFocusedWidget() Returns the widget which is in focus of a panel or comprehensive widget.
boolean	isInFocus() Returns true if this widget is the focused one.
boolean	isVisible() Returns whether the widget is visible or not.
boolean	remove() Removes all data and all widgets of this class.
void	removeImplWidget_Gthread() Removes the implementation widget, maybe to re-create with changed properties or also if the GralWidget itself should be removed.
void	set(java.util.List<java.lang.String[]> listData)
void	setFocus() Sets the focus of the associated table widget.
void	setFocus(int delay, int latest)
void	setFocusedWidget(GralWidgetBase_ifc widg) If this widget is a comprehensive widget or a panel, it sets one of the content as focused.
void	setLeftRightKeys(int keyLeft, int keyRight) The left and right key codes for selection left and right can be changed.
void	setLeftRightKeys(int keyLeft, int keyRight, int keyLeft2, int keyRight2) The two left and right key codes for selection left and right can be changed.
boolean	setVisible(boolean visible) Sets this widget visible on graphic or invisible.
(package private) void	stop()
void	XXXXsetToPanel(GralMngBuild_ifc gralMng)

Methods inherited from class org.vishia.gral.base.GralWidgetBase

checkImplWidgetCreation, createImplWidget, getImplAccess, getName, gralMng, hasFocus, pos, resizePostPreparation, setFocused, toString, toString

Methods inherited from class java.lang.Object

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

Field Detail

version

public static final java.lang.String version

Version and history:

• 2023-02-15 Hartmut new: second key set for entry/exit to left/right setLeftRightKeys(int, int, int, int)
• 2022-12-11 Hartmut chg: because new concept of Gral setToPanel is no more called. set the actionTable now in the ctor which would be also proper in the past but now necessary.
• 2018-10-28 Hartmut chg: createImplWidget_Gthread() instead setToPanel(mng)
• 2011-11-18 chg: This class does not inherit from GralWidget now. The GralWidget, which represents this class, is referenced with the public aggregation wdgdTable. Only this instance is registered on a panel calling #setToPanel(GralMngBuild_ifc, String, int, int[], char).
• 2011-10-02 chg: Uses keycodes from KeyCode now,
• 2011-10-02 chg: actionOk(Object, GralTableLine_ifc) returns boolean now, false if no action is done.
• older- TODO

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 indent 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

wdgdTable

public final GralTable<UserData> wdgdTable

The table which is showing in the widget.

keyLeft

protected int keyLeft

The keys for left and right navigation. Default it is shift + left and right arrow key.

keyLeft2

protected int keyLeft2

The keys for left and right navigation. Default it is shift + left and right arrow key.

keyRight

protected int keyRight

The keys for left and right navigation. Default it is shift + left and right arrow key.

keyRight2

protected int keyRight2

The keys for left and right navigation. Default it is shift + left and right arrow key.

actions

protected java.util.Map<java.lang.String,GralUserAction> actions

Not used yet, register actions?

actionTable

private final GralUserAction actionTable

This is the enhancement to key handling of a common table. It regards additionally keyleft and keyright, which is default use with the alt key. See setLeftRightKeys(int, int), calling actionLeft(Object, GralTableLine_ifc) and actionRight(Object, GralTableLine_ifc).
it supports also enter or double click which both calls actionOk(Object, GralTableLine_ifc) All other key codes calls actionUserKey(int, Object, GralTableLine_ifc) All this operations should be overridden by the implementing class.

Constructor Detail

GralSelectList

protected GralSelectList(GralPos refPos,
                         java.lang.String posName,
                         int rows,
                         int[] columns)

Method Detail

setLeftRightKeys

public final void setLeftRightKeys(int keyLeft,
                                   int keyRight,
                                   int keyLeft2,
                                   int keyRight2)

The two left and right key codes for selection left and right can be changed. The key code is a number maybe in combination with alt, ctrl, shift see KeyCode.

Parameters:

keyLeft - Key code for outer selection

keyRight - KeyCode for deeper selection

keyLeft2 - second Key code for outer selection

keyRight2 - second KeyCode for deeper selection

setLeftRightKeys

public final void setLeftRightKeys(int keyLeft,
                                   int keyRight)

The left and right key codes for selection left and right can be changed. The key code is a number maybe in combination with alt, ctrl, shift see KeyCode.

Parameters:

keyLeft - Key code for outer selection

keyRight - KeyCode for deeper selection

XXXXsetToPanel

public void XXXXsetToPanel(GralMngBuild_ifc gralMng)

Parameters:

panel -

identArgJbat -

rows -

columns -

size -

createImplWidget_Gthread

public boolean createImplWidget_Gthread()

Description copied from class: GralWidgetBase

This operation is called to create the implementation widget appearance. If is either overridden in the specific widget implemented in the GralWidget by the default behavior. Or it should be overridden in instances which are not derived from GralWidget itself, on instances of comprehensive widgets. This implementation is only called in GralWidget.createImplWidget_Gthread() for composite widgets.

Overrides:

createImplWidget_Gthread in class GralWidgetBase

Returns:

true if created.

removeImplWidget_Gthread

public void removeImplWidget_Gthread()

Removes the implementation widget, maybe to re-create with changed properties or also if the GralWidget itself should be removed. This is a internal operation not intent to use by an application. It is called from the GralMng#runGraphicThread() and hence package private.

Overrides:

removeImplWidget_Gthread in class GralWidgetBase

set

public void set(java.util.List<java.lang.String[]> listData)

setVisible

public boolean setVisible(boolean visible)

Description copied from interface: GralWidgetBase_ifc

Sets this widget visible on graphic or invisible. Any widget can be visible or not. More as one widgets can use the same position, only one of them may set visible. For a GralWindow, its the visibility of the whole window. Note that a window which is invisible is not shown in the task bar of the operation system. Note that an application can have more as one window. Note that a dialog window can be set to invisible if it is not need yet instead destroy and build newly.

Specified by:

setVisible in interface GralWidgetBase_ifc

Specified by:

setVisible in class GralWidgetBase

Returns:

isVisible

public boolean isVisible()

Description copied from interface: GralWidgetBase_ifc

Returns whether the widget is visible or not. This method can be invoked in any thread. It is an estimation because the state of the widget may be changed in the last time or a window can be covered by another one. The widget is not visible if it is a member of a card in a tabbed panel and that tab is not the selected one.

Specified by:

isVisible in interface GralWidgetBase_ifc

Overrides:

isVisible in class GralWidgetBase

Returns:

true if the widget seams to be visible.

isInFocus

public boolean isInFocus()

Description copied from interface: GralWidgetBase_ifc

Returns true if this widget is the focused one.

setFocus

public void setFocus()

Sets the focus of the associated table widget.

setFocus

public void setFocus(int delay,
                     int latest)

setFocusedWidget

public void setFocusedWidget(GralWidgetBase_ifc widg)

Description copied from interface: GralWidgetBase_ifc

If this widget is a comprehensive widget or a panel, it sets one of the content as focused.

Parameters:

widg - The sub widget which should be focused. It influences for example the current tab of a tabbed panel, or influences which widget of a comprehensive widget is first focused. On a panel it determines which widget should get the focus if the panel gets the focus.

getFocusedWidget

public GralWidgetBase_ifc getFocusedWidget()

Description copied from interface: GralWidgetBase_ifc

Returns the widget which is in focus of a panel or comprehensive widget. This allows quests about the status of the widget, for example the opened tab on a tabbed panel of which is in use currently from a comprehensive widget.

remove

public boolean remove()

Removes all data and all widgets of this class.

Overrides:

remove in class GralWidgetBase

actionOk

protected abstract boolean actionOk(java.lang.Object userData,
                                    GralTableLine_ifc<UserData> line)

Action if a table line is selected and entered. Its either a double click with the mouse or click of OK (Enter) button.

Parameters:

userData - The user data stored in the line of table.

actionLeft

protected abstract void actionLeft(java.lang.Object userData,
                                   GralTableLine_ifc<UserData> line)

Action if a table line is selected and ctrl-left is pressed or the release button is pressed.

Parameters:

userData - The user data stored in the line of table.

actionRight

protected abstract void actionRight(java.lang.Object userData,
                                    GralTableLine_ifc<UserData> line)

Action if a table line is selected and ctrl-right is pressed or the release button is pressed.

Parameters:

userData - The user data stored in the line of table.

actionUserKey

protected abstract boolean actionUserKey(int key,
                                         java.lang.Object userData,
                                         GralTableLine_ifc<UserData> line)

Action if a table line is selected and any other key is pressed or the context menu is invoked.

Parameters:

key - code or mouse code, one of constans from KeyCode.

userData - The user data stored in the line of table.

line - The table line.

Returns:

true if is was relevant for the key.

stop

void stop()