org.vishia.gral.base

Class GralWidgetBase

java.lang.Object

org.vishia.gral.base.GralWidgetBase

All Implemented Interfaces:

GralWidgetBase_ifc

Direct Known Subclasses:

GralFileProperties, GralFileSelector, GralSelectList, GralViewFileContent, GralWidget

public abstract class GralWidgetBase
extends java.lang.Object
implements GralWidgetBase_ifc

It is the base class for all widgets, via GralWidget as common base class for all regular widgets, but as base class without inheritance of 'GralWidget' for composite widgets such as GralFileSelector. It contains only the basically data, especially name, the GralPos and the reference to the GralMng But it contains also via _cdata all information for composite widgets.

The bVisibleState and bHasFocus are the only dynamically data common for all widgets, contained here. See isVisible() and hasFocus().

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	GralWidgetBase.GralWidgComposite This inner class is used for the instance _cdata if the widget is a composite widget.
static class	GralWidgetBase.TimeOrderCreateImplWidget Instance of a 'GralGraphicOrder' to create the implementation of only one widget.

Field Summary

Fields

Modifier and Type	Field and Description
GralWidgetBase.GralWidgComposite	_cdata If this widget is a composite widget (panel, complex widget), from this instance the members are referenced.
protected GralPos	_wdgPos The position of the widget.
private boolean	bHasFocus Set on focus gained, false on focus lost.
protected boolean	bVisibleState Set true if its shell, tab card etc is be activated.
GralMng	gralMng The widget manager from where the widget is organized.
java.lang.String	name Name of the widget in the panel.
GralRectangle	pixSize
static java.lang.String	sVersion Version, history and license.

Constructor Summary

Constructors

Constructor and Description
GralWidgetBase(GralPos refPos, java.lang.String sPosName, boolean isComposite)
GralWidgetBase(GralPos refPos, java.lang.String sPosName, GralMng gralMng) Deprecated.
GralWidgetBase(GralPos refPos, java.lang.String sPosName, GralMng gralMng, boolean isComposite) Either the GralMng is given, or pos should be given, then the GralMng is gotten from GralPos.parent.

Method Summary

Modifier and Type	Method and Description
boolean	checkImplWidgetCreation(GralWidget.ImplAccess wdgImpl) Checks whether the creation of the implementation widget is admissible
boolean	createImplWidget_Gthread() This operation is called to create the implementation widget appearance.
boolean	createImplWidget() Should create the implementation widget.
GralWidget.ImplAccess	getImplAccess() This is used to access to the implementation widget instance.
java.lang.String	getName() Access to the name of the widget.
GralMng	gralMng() Returns the associated GralMng.
boolean	hasFocus()
boolean	isVisible() Returns whether the widget is visible or not.
GralPos	pos() Position of the widget, which refers also the GralPos.parent.
boolean	remove() Removes the widget from the lists in its panel and from the graphical representation.
void	removeImplWidget_Gthread() Removes the implementation widget, maybe to re-create with changed properties or also if the GralWidget itself should be removed.
protected void	resizePostPreparation() This operation is called after the widget itself was resized but not just redrawn.
void	setFocused(boolean bGained) This operation should be called from the implementation graphic if the focus was changed for an implementation widget by user handling.
abstract boolean	setVisible(boolean visible) Sets this widget visible on graphic or invisible.
java.lang.String	toString() Especially for test and debug, short info about widget.
java.lang.StringBuilder	toString(java.lang.StringBuilder u, java.lang.String... cond)

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.GralWidgetBase_ifc

getFocusedWidget, isInFocus, setFocus, setFocus, setFocusedWidget

Field Detail

sVersion

public static final java.lang.String sVersion

Version, history and license.

• 2023-04-17 Hartmut new
  • GralWidgetBase.GralWidgComposite as inner class for composite widgets, also for GralPanelContent as also for comprehensive widgets as container for all Gral sub widgets.
  • Resizing is done for all children widgets in GralWidgetBase.GralWidgComposite.resizeWidgets(GralRectangle, int).
  • pixSize is set while resizing
  • properties hasFocus() ( bHasFocus and bVisibleState is stored and handled here.
• 2022-12-17 Hartmut new createImplWidget() able to call in any thread, to create the implementation widget afterwards.
• 2022-06-00 Hartmut created, It was now obviously, that comprehensive widgets are necessary, they need the

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 is 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 doesn'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 intent to use this source without publishing its usage, you can get a second license subscribing a special contract with the author.

See Also:

Constant Field Values

gralMng

public final GralMng gralMng

The widget manager from where the widget is organized. Most of methods need the information stored in the panel manager. This reference is used to set values to other widgets.

_wdgPos

protected final GralPos _wdgPos

The position of the widget. The GralPos contains also the reference to the parent composite panel GralPanel_ifc which contains the widget.

name

public final java.lang.String name

Name of the widget in the panel.

_cdata

public final GralWidgetBase.GralWidgComposite _cdata

If this widget is a composite widget (panel, complex widget), from this instance the members are referenced. It is null for a simple widget. Architecture: With this intermediate instance not all GralWidgetBase needs all references which are often unused. Only this one reference is given then.

bHasFocus

private boolean bHasFocus

Set on focus gained, false on focus lost.

pixSize

public final GralRectangle pixSize

bVisibleState

protected boolean bVisibleState

Set true if its shell, tab card etc is be activated. Set false if it is deactivated. It is an estimation whether this widget is be shown yet.

Constructor Detail

GralWidgetBase

@Deprecated
public GralWidgetBase(GralPos refPos,
                                   java.lang.String sPosName,
                                   GralMng gralMng)

Deprecated.

GralWidgetBase

public GralWidgetBase(GralPos refPos,
                      java.lang.String sPosName,
                      boolean isComposite)

GralWidgetBase

public GralWidgetBase(GralPos refPos,
                      java.lang.String sPosName,
                      GralMng gralMng,
                      boolean isComposite)

Either the GralMng is given, or pos should be given, then the GralMng is gotten from GralPos.parent. If both are null, the GralMng#get() is used as fallback for compatibility.

Parameters:

refPos -

sPosName - syntax "[@[@] [= <$?name>] | <$?name>].

gralMng -

true - then creates the _cdata instance.

Method Detail

getName

public java.lang.String getName()

Access to the name of the widget. But you can also access the final public name immediately. Defined in GralWidgetBase_ifc.getName()

Specified by:

getName in interface GralWidgetBase_ifc

Returns:

the name

pos

public final GralPos pos()

Position of the widget, which refers also the GralPos.parent. The parent in a GralPos has usual the reference to the GralMng.

Specified by:

pos in interface GralWidgetBase_ifc

Returns:

the position, always available, never null.

gralMng

public final GralMng gralMng()

Returns the associated GralMng. The GralMng is associated by construction,

Specified by:

gralMng in interface GralWidgetBase_ifc

setVisible

public abstract 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

Returns:

setFocused

public void setFocused(boolean bGained)

This operation should be called from the implementation graphic if the focus was changed for an implementation widget by user handling. It does not change the focus state in the implementation widget, it denotes only that the GralWidget has the focus or not.
It is also called for all parents of a widget if a child gets the focus. The specific widget implementation can override this operation to do specifics. It should call super.focused(bGained) to forward the focus to parents.

Specified by:

setFocused in interface GralWidgetBase_ifc

Parameters:

bGained -

hasFocus

public boolean hasFocus()

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

Returns:

true if the widget seams to be visible.

resizePostPreparation

protected void resizePostPreparation()

This operation is called after the widget itself was resized but not just redrawn. It is called from GralWidgetBase.GralWidgComposite.resizeWidgets(GralRectangle, int) If some specific resize operations should be done for redraw (for example calculate which implementation widgets are visible) Then this operation should be overridden. It is done for example in GralTable.resizePostPreparation().

createImplWidget_Gthread

public boolean createImplWidget_Gthread()
                                 throws java.lang.IllegalStateException

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.

Returns:

true if created.

Throws:

java.lang.IllegalStateException - if called though the GralMng is not implemented.

checkImplWidgetCreation

public final boolean checkImplWidgetCreation(GralWidget.ImplAccess wdgImpl)

Checks whether the creation of the implementation widget is admissible

Parameters:

implAccess - use this._widgImpl for a normal widget, or use one of the (the primary) widgets of a comprehensive widget to check whether the implementation is also done.

Returns:

true if ok, false if widget exists already

Throws:

java.lang.IllegalStateException - if this function is called and the implementation manager is not given. It is before call GralMng#createGraphic(String, char, org.vishia.msgDispatch.LogMessage).

createImplWidget

public final boolean createImplWidget()

Should create the implementation widget. This operation should be called on new created Gral Widgets if it is able to suppose that the parent is created already. This is definitely on new widgets in runtime. If the conditions to create are given, either immediately the createImplWidget_Gthread() is called if it is in the graphic thread, or a GralGraphicTimeOrder is created to do so in the graphic thread. It means this operation can be called in any thread. Calls the overridden GralWidget.createImplWidget_Gthread()

Returns:

true if created or the time order for creation is started. false if creation is not possible yet.

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.

remove

public boolean remove()

Removes the widget from the lists in its panel and from the graphical representation. If the graphic implementation is given, then GralWidgImplAccess_ifc.removeWidgetImplementation() is called which is overridden in the graphic implementation sources in a specific kind (SWT: for example SwtTextFieldWrapper.removeWidgetImplementation()) It calls the protected GralWidgetBase.GralWidgComposite.removeWidget(GralWidgetBase) and also GralMng.deregisterWidgetName(GralWidgetBase).

getImplAccess

public GralWidget.ImplAccess getImplAccess()

Description copied from interface: GralWidgetBase_ifc

This is used to access to the implementation widget instance. For comprehensive widgets one of the implementation widgets is returned which has a main functionality.

Specified by:

getImplAccess in interface GralWidgetBase_ifc

Returns:

toString

public java.lang.String toString()

Especially for test and debug, short info about widget.

Overrides:

toString in class java.lang.Object

See Also:

Object.toString()

toString

public java.lang.StringBuilder toString(java.lang.StringBuilder u,
                                        java.lang.String... cond)