org.vishia.gral.base

Class GralPanelContent

java.lang.Object

org.vishia.gral.base.GralWidgetBase

org.vishia.gral.base.GralWidget

org.vishia.gral.base.GralPanelContent

All Implemented Interfaces:

GetGralWidget_ifc, GralPanel_ifc, GralSetValue_ifc, GralVisibleWidgets_ifc, GralWidget_ifc, GralWidgetBase_ifc

Direct Known Subclasses:

GralArea9Panel

public class GralPanelContent
extends GralWidget
implements GralPanel_ifc, GralWidget_ifc, GralVisibleWidgets_ifc

This class describes a panel which contains either some other widgets (also sub GralPanelContent) or as second variant tabs (new since 2022-08). For a tabbed panel call setToTabbedPanel() and add only panels.
The implementing widget in Swt is a Composite, a Canvas or just a TabFolder. To support showing lines and figures a canvas() is referenced here. It means the GralPanelContent can contain lines, figures beside widgets.
For positioning grid lines can be drawn in the implementing graphic.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	GralPanelContent.ActionSetFromTabSelection This class is instantiated and used for a GralHorizontalSelector as action for tab is selection and rmove.
static class	GralPanelContent.Data
static class	GralPanelContent.ImplAccess

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

GralWidget.ActionChangeSelect, GralWidget.ConfigData, GralWidget.DynamicData

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

GralWidgetBase.GralWidgComposite, GralWidgetBase.TimeOrderCreateImplWidget

Nested classes/interfaces inherited from interface org.vishia.gral.ifc.GralWidget_ifc

GralWidget_ifc.ActionChange, GralWidget_ifc.ActionChangeWhen

Field Summary

Fields

Modifier and Type	Field and Description
GralPanelContent.Data	_panel
static java.lang.String	version Version history: 2023-08-02: Hartmut cleanup: ctor without extra GralMng.

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

_wdgImpl, bEditable, bShouldInitialize, cfg, contextMenu, dateUser, dyda, htmlHelp, lastTimeSetVisible, redrawDelayMax, redrawtDelay, sCmd, sFormat, showWidgetInfo, sToolTip, sVersion, whatIs, XXXbuildMng

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

_cdata, _wdgPos, bVisibleState, gralMng, name, pixSize

Fields inherited from interface org.vishia.gral.ifc.GralWidget_ifc

sVersion

Constructor Summary

Constructors

Constructor and Description
GralPanelContent(GralPos currPos, java.lang.String posName)
GralPanelContent(GralPos currPos, java.lang.String posName, java.lang.String labelTab)
GralPanelContent(GralPos refPos, java.lang.String posName, java.lang.String labelTab, char whatIsit) Create a panel, registers it and sets the refPos to this panel.

Method Summary

Modifier and Type	Method and Description
GralPanelContent	addTabPanel(java.lang.String name, java.lang.String tabLabel, boolean removable) Adds a new panel as Tab for this tabbed panel.
GralCanvasStorage	canvas()
GralCanvasStorage	getCreateCanvas() Returns the GralCanvasStorage for this panel, creates one if not given yet.
GralWidgetBase_ifc	getFocusedWidget() Default implementation for a widget without children
GralWidget	getPanelWidget()
java.lang.String	getTextFrom(java.lang.String nameWidget) Gets the text from the named widget
GralWidgetBase	getWidget(java.lang.String name) Gets a named widget on this panel.
java.lang.Object	getWidgetImplementation() Deprecated.
java.util.List<GralWidgetBase>	getWidgetList()
java.util.List<GralWidgetBase>	getWidgetsToResize()
java.util.List<GralWidgetBase>	getWidgetsVisible() Gets the list of all widgets which are visible yet and should be updated with values therefore.
boolean	isTabbed()
boolean	remove() This overridden form of GralWidget_ifc#remove() removes all widgets of this panel.
void	removeWidget(GralWidget widg) Remove a dedicated widget from the panel.
boolean	removeWidget(java.lang.String name) Removes a widget in this panel given by name.
(package private) void	reportAllContent(java.lang.Appendable out, int level) Returns the container instance of the panel of the implementing graphic.
void	setFocusedWidget(GralWidgetBase_ifc widg) The primary widget is that widget which should be focused if the panel is focused.
void	setGrid(int yGrid, int xGrid, int yGrid2, int xGrid2, int colordiff, int colordiff2) If yGrid and xGrid are >0, show a grid.
void	setPanelVisible(boolean bVisible)
void	setTextIn(java.lang.String nameWidget, java.lang.CharSequence text) Sets the text to the named widget
void	setToTabbedPanel() Should be set before call of #addWidget(GralWidget, boolean).
java.lang.String	toString() Especially for test and debug, short info about widget.
java.util.List<GralWidgetBase>	widgetList() Deprecated. use getWidgetList()
boolean	XXXsetFocusGThread() Sets the focus to the primary widget if it is set.

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

clearShowParam, createImplWidget_Gthread, getActionChange, getActionChangeStrict, getActionDrag, getActionDrop, getActionFocused, getActionShow, getBackColor, getCfgElement, getCmd, getCmd, getContentIdent, getContentInfo, getContextMenu, getData, getDataIx, getDataPath, getDataPath, getFloatValue, getFormat, getGralWidget, getHtmlHelp, getImplAccess, getImplWidget, getItsPanel, getLongValue, getName, getShowMethod, getShowParam, getsToolTip, getText, getValue, getVariable, getVariableFromContentInfo, isChanged, isEditable, isGraphicDisposed, isInFocus, isNotEditableOrShouldInitialize, isVisible, redraw, redraw, redraw, redraw1, redrawOnlyDynamics, refreshFromVariable, refreshFromVariable, removeImplWidget_Gthread, requestNewValueForVariable, setActionChange, setActionFocused, setActionMouse, setActionShow, setBackColor, setBackgroundColor, setBoundsPixel, setCfgElement, setCmd, setContentIdent, setContentInfo, setData, setDataIx, setDataPath, setDragEnable, setDropEnable, setEditable, setFocus, setFocus, setForegroundColor, setFormat, setHtmlHelp, setLineColor, setLongValue, setMinMax, setPrimaryWidgetOfPanel, setText, setTextColor, setToolTip, setToPanel, setValue, setValue, setValue, setValue, setVariable, setVisible, specifyActionChange, specifyContextMenu, stop, toString, XXXgetWidgetImplementation, XXXremoveWidgetImplementation, XXXrepaintGthread

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

checkImplWidgetCreation, createImplWidget, gralMng, hasFocus, pos, resizePostPreparation, setFocused

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.vishia.gral.ifc.GralPanel_ifc

pos

Methods inherited from interface org.vishia.gral.ifc.GralWidget_ifc

getActionChange, getBackColor, getCmd, getContentIdent, getContentInfo, getData, getDataPath, getImplWidget, isChanged, isEditable, isGraphicDisposed, isNotEditableOrShouldInitialize, redraw, redraw, refreshFromVariable, refreshFromVariable, setBackColor, setBackgroundColor, setBoundsPixel, setCmd, setContentIdent, setData, setDataPath, setEditable, setFocus, setForegroundColor, setHtmlHelp, setLineColor, setText, setTextColor

Methods inherited from interface org.vishia.gral.ifc.GralWidgetBase_ifc

getImplAccess, getName, gralMng, isInFocus, isVisible, setFocus, setFocused, setVisible

Field Detail

version

public static final java.lang.String version

Version history:

• 2023-08-02: Hartmut cleanup: ctor without extra GralMng. The reference to it is contained in GralPos.
• 2023-04-15: Because of new aggregated GralWidgetBase._cdata class GralWidgComposite some operations are located there.
• 2023-01-20: refactoring: up to now the swt.TabFolder and TabItem is no more used. Instead a GralHorizontalSelector is used to select panels. The panels are normal panels which are set visible or invisible. Also remove a tab is possible.
• 2022-11-15: new #addTabPanel(String, String), removeWidget(String)
• 2022-11-12: can replace the GralWindow.mainPanel now if another panel type is given to build. See GralPanelContent#GralPanelContent(GralPos, String, char, GralMng).
• 2022-09-25: own colors for grid lines used in implementation.
• 2022-09-14: new #reportAllContent(Appendable)
• 2022-08: Data#bTabbed as designation, this is a tabbed panel. The old class GralTabbedPanel is no more necessary.
• 2022-08: New class GralPanelContent.Data to encapsulate all elements of this. It is better to view in debug to distinguish form GralWidget fields.
• 2018-08-17 Hartmut new: getWidget(String), getTextFrom(String)
• 2016-07-16 Hartmut chg: On #setToPanel(GralMngBuild_ifc) all widgets of this panel are initialized too. More simple for user application.
• 2015-05-02 Hartmut new: setTextIn(String, CharSequence), change of registering a widget. Now any panel knows its widgets by name.
• 2012-07-13 Hartmut new: #getPixelSize(), chg: #getPixelPositionSize() in all implementations. A swt.widget.Shell now returns the absolute position and the real size of its client area without menu and title bar.
• 2012-04-22 Hartmut new: canvas() as property maybe null for each panel to support stored graphics. // *
• 2012-03-31 Hartmut new: #implMethodPanel_ and MethodsCalledbackFromImplementation#setVisibleState(boolean).
• 2012-01-14 Hartmut new: #setFocusedWidget(GralWidget) for panel focus.
• 2012-01-08 Hartmut new: remove()
• 2011-11-19 Hartmut chg: The 'itsTabSwt' is moved to SwtPanel now.
• 2011-11-12 Hartmut new: #getPixelPositionSize().

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

_panel

public final GralPanelContent.Data _panel

Constructor Detail

GralPanelContent

public GralPanelContent(GralPos refPos,
                        java.lang.String posName,
                        java.lang.String labelTab,
                        char whatIsit)

Create a panel, registers it and sets the refPos to this panel.

Parameters:

refPos - reference position, also with aggregation to the GralMng

posName - possible position string in the parent, starting with "@..." and the name

labelTab - =null for a whatIsit ==$ :simple panel, if given for whatIsit ==^ :tabbed panel, then the first tab is created as select list for all tabs. should be given as string, name of the tab for whatIsit ==@ TODO remove this arg, use only addTabPanel(String, String, boolean) to create a tabbed panel with tabs.

whatIsit - should be one of $ ^ @ for $=simple panel, ^=a tabbed panel, @= a tab of a tabbed panel

gralMng -

GralPanelContent

public GralPanelContent(GralPos currPos,
                        java.lang.String posName)

GralPanelContent

public GralPanelContent(GralPos currPos,
                        java.lang.String posName,
                        java.lang.String labelTab)

Method Detail

setFocusedWidget

public void setFocusedWidget(GralWidgetBase_ifc widg)

The primary widget is that widget which should be focused if the panel is focused. If this is a tabed panel the focused widget is the current opened tab. It is possible to set any actual widget to store the focus situation, It is possible too to have only one widget to focus. if the panel gets the focus.

Specified by:

setFocusedWidget in interface GralWidgetBase_ifc

Overrides:

setFocusedWidget in class GralWidget

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.

setPanelVisible

public void setPanelVisible(boolean bVisible)

setToTabbedPanel

public void setToTabbedPanel()

Should be set before call of #addWidget(GralWidget, boolean). Then the widgets are presented as tabs in this panel. The widgets then are usual GralPanelContent by itself or a more complex GralWidget, for example a GralTable. This feature can only be set initially, not removed.

addTabPanel

public GralPanelContent addTabPanel(java.lang.String name,
                                    java.lang.String tabLabel,
                                    boolean removable)

Adds a new panel as Tab for this tabbed panel. The panel must not contain any other widgets before. setToTabbedPanel() is called here.

Parameters:

name - name of the panel in the GralMng.

tabLabel - label shown on the tab.

Returns:

a new created panel as child of this panel, which acts as tab

setGrid

public void setGrid(int yGrid,
                    int xGrid,
                    int yGrid2,
                    int xGrid2,
                    int colordiff,
                    int colordiff2)

If yGrid and xGrid are >0, show a grid. For tabbed panels show the grid for all tabs. If yGrid==0 or xGrid ==0 does not show a grid.

Parameters:

yGrid -

xGrid -

yGrid2 -

xGrid2 -

remove

public boolean remove()

This overridden form of GralWidget_ifc#remove() removes all widgets of this panel. It includes the disposition of the widgets in the graphic. It is done by invocation GralWidgetBase.remove().

Overrides:

remove in class GralWidgetBase

Returns:

true because it is done.

removeWidget

public boolean removeWidget(java.lang.String name)

Removes a widget in this panel given by name. It searches the widget in this panel (Data#idxWidgets) and calls GralWidgetBase.remove(). It removes also the implementing widget.

Parameters:

name - name of the widget for GralMng as also in the Data#idxWidgets

Returns:

true then widget is removed, false: Widget not exists here.

removeWidget

public void removeWidget(GralWidget widg)

Remove a dedicated widget from the panel.

Specified by:

removeWidget in interface GralPanel_ifc

canvas

public GralCanvasStorage canvas()

Specified by:

canvas in interface GralPanel_ifc

getCreateCanvas

public GralCanvasStorage getCreateCanvas()

Returns the GralCanvasStorage for this panel, creates one if not given yet. This operation is intended to use for adding a Figure to the panel's canvas.

Returns:

The composite instance of the canvas storage.

isTabbed

public boolean isTabbed()

getPanelWidget

public GralWidget getPanelWidget()

Specified by:

getPanelWidget in interface GralPanel_ifc

getFocusedWidget

public GralWidgetBase_ifc getFocusedWidget()

Description copied from class: GralWidget

Default implementation for a widget without children

Specified by:

getFocusedWidget in interface GralWidgetBase_ifc

Overrides:

getFocusedWidget in class GralWidget

Returns:

null, nonsense.

widgetList

@Deprecated
public java.util.List<GralWidgetBase> widgetList()

Deprecated. use getWidgetList()

getWidgetList

public java.util.List<GralWidgetBase> getWidgetList()

Specified by:

getWidgetList in interface GralPanel_ifc

getWidgetsVisible

public java.util.List<GralWidgetBase> getWidgetsVisible()

Description copied from interface: GralVisibleWidgets_ifc

Gets the list of all widgets which are visible yet and should be updated with values therefore.

Specified by:

getWidgetsVisible in interface GralVisibleWidgets_ifc

Returns:

The list.

getWidgetsToResize

public java.util.List<GralWidgetBase> getWidgetsToResize()

getWidget

public GralWidgetBase getWidget(java.lang.String name)

Gets a named widget on this panel. Returns null if faulty name.

Since:

2018-09

setTextIn

public void setTextIn(java.lang.String nameWidget,
                      java.lang.CharSequence text)

Sets the text to the named widget

Parameters:

nameWidget - the registered widget in its panel.

text - The text to set.

Throws:

java.lang.IllegalArgumentException - on faulty widget name

Since:

2015-05-02

getTextFrom

public java.lang.String getTextFrom(java.lang.String nameWidget)

Gets the text from the named widget

Parameters:

nameWidget - the registered widget in its panel.

text - The text to set.

Throws:

java.lang.IllegalArgumentException - on faulty widget name

Since:

2015-05-02

XXXsetFocusGThread

public boolean XXXsetFocusGThread()

Sets the focus to the primary widget if it is set. Elsewhere do nothing and returns false. The focus may be set then by the inherit implementation class.
See #setFocusedWidget(GralWidget).

Overrides:

XXXsetFocusGThread in class GralWidget

Returns:

true if the focus is set to the primary widget.

getWidgetImplementation

@Deprecated
public java.lang.Object getWidgetImplementation()

Deprecated.

Use GralWidet._wdgImpl.getWidgetImplementation() internally! Not public.

Returns:

reportAllContent

void reportAllContent(java.lang.Appendable out,
                      int level)
               throws java.io.IOException

Returns the container instance of the panel of the implementing graphic.

Throws:

java.io.IOException

toString

public java.lang.String toString()

Description copied from class: GralWidget

Especially for test and debug, short info about widget.

Overrides:

toString in class GralWidget

See Also:

Object.toString()