org.vishia.gral.base

Class GralScreen

java.lang.Object

org.vishia.gral.base.GralScreen

All Implemented Interfaces:

GralPanel_ifc, GralWidget_ifc, GralWidgetBase_ifc

public class GralScreen
extends java.lang.Object
implements GralPanel_ifc

Dummy implementation of the Screen as top level panel. Only to prevent a null pointer. May be used more elaborately in future

Since:

2022-08

Nested Class Summary

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
private GralWindow	focusedWindow
private GralMng	gralMng

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

sVersion

Constructor Summary

Constructors

Constructor and Description
GralScreen(GralMng gralMng)

Method Summary

Modifier and Type	Method and Description
GralCanvasStorage	canvas()
GralWidget_ifc.ActionChange	getActionChange(GralWidget_ifc.ActionChangeWhen when)
GralColor	getBackColor(int ix) Gets the background color for the widget.
java.lang.String	getCmd() Any widget can have a command String, which can be quest for example in an action.
long	getContentIdent() Gets the content identification of the users data which are set with GralWidget_ifc.setContentIdent(long).
java.lang.Object	getContentInfo()
java.lang.Object	getData() Gets the application specific info.
java.lang.String	getDataPath()
GralWidgetBase_ifc	getFocusedWidget() Returns the widget which is in focus of a panel or comprehensive widget.
GralWidget.ImplAccess	getImplAccess() This is used to access to the implementation widget instance.
java.lang.Object	getImplWidget() Returns the implementation widget or its Wrapper.
java.lang.String	getName() Access to the name of the widget.
GralWidget	getPanelWidget()
java.util.List<GralWidgetBase>	getWidgetList()
GralMng	gralMng() Returns the associated GralMng.
boolean	isChanged(boolean setUnchanged) Returns true if the content is changed from a user action on GUI.
boolean	isEditable() Query whether this widget is able to change from user handling.
boolean	isGraphicDisposed() Returns true if the graphic implementatin widget was initialized, and then it was disposed.
boolean	isInFocus() Returns true if this widget is the focused one.
boolean	isNotEditableOrShouldInitialize() Query whether this field should be written from any initial or actual data.
boolean	isVisible() Returns whether the widget is visible or not.
GralPos	pos() Position of the widget, which refers also the GralPos.parent.
void	redraw() repaint request.
void	redraw(int delay, int latest) Possible delayed repaint, can be called in any thread.
void	refreshFromVariable(VariableContainer_ifc container) Capability for any widget to update its content from its associated variables described in its sDataPath.
void	refreshFromVariable(VariableContainer_ifc container, long timeAtleast, GralColor colorRefreshed, GralColor colorOld) Capability of any widget for GralWidget_ifc.refreshFromVariable(VariableContainer_ifc) but additionally the widget is shown as "too old" if the time stored with the variable is old.
boolean	remove()
void	removeWidget(GralWidget widg) Only used internally
void	setBackColor(GralColor color, int ix) Sets the background color for the widget.
GralColor	setBackgroundColor(GralColor color)
void	setBoundsPixel(int x, int y, int dx, int dy) This operation is used if the pixel are calculated on gral level.
void	setCmd(java.lang.String cmd) Any widget can have a command String, which can be quest for example in an action.
long	setContentIdent(long ident) Sets a identification for the shown data.
void	setData(java.lang.Object data) Sets a application specific data.
void	setDataPath(java.lang.String sDataPath) Sets the data path.
void	setEditable(boolean editable) Sets whether it is able to edit the content of the text field or text box.
void	setFocus() Sets the focus to the widget. .
void	setFocus(int delay, int latest) Sets the focus to the widget. .
void	setFocused(boolean bGained) This operation can be called from the implementation graphic if the focus is gained for an implementation widget.
void	setFocusedWidget(GralWidgetBase_ifc widg) If this widget is a comprehensive widget or a panel, it sets one of the content as focused.
GralColor	setForegroundColor(GralColor color)
void	setHtmlHelp(java.lang.String url) Sets the html help url for this widget.
void	setLineColor(GralColor color, int ix) Sets the line color for the widget.
void	setText(java.lang.CharSequence text) Set the text of the widget.
void	setTextColor(GralColor color) Sets the text color for the widget.
boolean	setVisible(boolean visible) Sets this widget visible on graphic or invisible.

Methods inherited from class java.lang.Object

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

Field Detail

gralMng

private final GralMng gralMng

focusedWindow

private GralWindow focusedWindow

Constructor Detail

GralScreen

public GralScreen(GralMng gralMng)

Method Detail

getName

public java.lang.String getName()

Description copied from interface: GralWidgetBase_ifc

Access to the name of the widget. But you can also access the final public GralWidgetBase.name immediately.

Specified by:

getName in interface GralWidgetBase_ifc

Returns:

the name

getDataPath

public java.lang.String getDataPath()

Specified by:

getDataPath in interface GralWidget_ifc

setCmd

public void setCmd(java.lang.String cmd)

Description copied from interface: GralWidget_ifc

Any widget can have a command String, which can be quest for example in an action. The widget can be identified by its GralWidget_ifc.getCmd() independent of its name which can be set on runtime with this method.

Specified by:

setCmd in interface GralWidget_ifc

getCmd

public java.lang.String getCmd()

Description copied from interface: GralWidget_ifc

Any widget can have a command String, which can be quest for example in an action. The widget can be identified by this method independent of its name. See GralWidget_ifc.setCmd(String).

Specified by:

getCmd in interface GralWidget_ifc

setData

public void setData(java.lang.Object data)

Description copied from interface: GralWidget_ifc

Sets a application specific data. It should help to present user data which are associated to this widget. This info can be set and changed anytime.

Specified by:

setData in interface GralWidget_ifc

getData

public java.lang.Object getData()

Description copied from interface: GralWidget_ifc

Gets the application specific info. See #setContentInfo(Object).

Specified by:

getData in interface GralWidget_ifc

getActionChange

public GralWidget_ifc.ActionChange getActionChange(GralWidget_ifc.ActionChangeWhen when)

Specified by:

getActionChange in interface GralWidget_ifc

gralMng

public GralMng gralMng()

Description copied from interface: GralWidgetBase_ifc

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

Specified by:

gralMng in interface GralWidgetBase_ifc

setFocus

public void setFocus()

Description copied from interface: GralWidgetBase_ifc

Sets the focus to the widget. . It can be called in any thread. If it is called in the graphic thread, the repaint action is executed immediately in the thread. Elsewhere the graphic thread will be woken up.

Specified by:

setFocus in interface GralWidgetBase_ifc

setFocus

public void setFocus(int delay,
                     int latest)

Description copied from interface: GralWidget_ifc

Sets the focus to the widget. . It can be called in any thread. If it is called in the graphic thread, the repaint action is executed immediately in the thread. Elsewhere the graphic thread will be woken up.

Specified by:

setFocus in interface GralWidget_ifc

Specified by:

setFocus in interface GralWidgetBase_ifc

isInFocus

public boolean isInFocus()

Description copied from interface: GralWidgetBase_ifc

Returns true if this widget is the focused one.

Specified by:

isInFocus in interface GralWidgetBase_ifc

setFocused

public void setFocused(boolean bGained)

This operation can be called from the implementation graphic if the focus is gained for an implementation widget. 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 -

isGraphicDisposed

public boolean isGraphicDisposed()

Description copied from interface: GralWidget_ifc

Returns true if the graphic implementatin widget was initialized, and then it was disposed. It is able to use especially to detect whether a sub window is closed or if the primary window was closed, to finish any other (waiting) thread. It may be used on any disposed widget.

Specified by:

isGraphicDisposed in interface GralWidget_ifc

Returns:

true if the Widget was created and after them disposed again.

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

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

Returns:

true if the widget seams to be visible.

setEditable

public void setEditable(boolean editable)

Description copied from interface: GralWidget_ifc

Sets whether it is able to edit the content of the text field or text box. If a content is not able to edit, it is a showing field or box. The user can't change the content. But the user can set the cursor, select any text and copy to the systems clipboard. If the content is able to edit, the change should be notified and the content should be gotten. To do that TODO

Specified by:

setEditable in interface GralWidget_ifc

Parameters:

editable - true then the content is going to be able to change. False then the edit functionality is disabled.

isEditable

public boolean isEditable()

Description copied from interface: GralWidget_ifc

Query whether this widget is able to change from user handling.

Specified by:

isEditable in interface GralWidget_ifc

isNotEditableOrShouldInitialize

public boolean isNotEditableOrShouldInitialize()

Description copied from interface: GralWidget_ifc

Query whether this field should be written from any initial or actual data.

Specified by:

isNotEditableOrShouldInitialize in interface GralWidget_ifc

setBackgroundColor

public GralColor setBackgroundColor(GralColor color)

Specified by:

setBackgroundColor in interface GralWidget_ifc

setForegroundColor

public GralColor setForegroundColor(GralColor color)

Specified by:

setForegroundColor in interface GralWidget_ifc

setBackColor

public void setBackColor(GralColor color,
                         int ix)

Description copied from interface: GralWidget_ifc

Sets the background color for the widget. It supports widgets with more as one background color by an index. The usage of the index is widget-specific. An index -1 should mean: All backgrounds. ix=0 means the first background.

Specified by:

setBackColor in interface GralWidget_ifc

Parameters:

color - Any color

ix - -1 for non-specific, 0 for the first color or if only one color is supported, 1, ... if the widget has more as one background.

getBackColor

public GralColor getBackColor(int ix)

Description copied from interface: GralWidget_ifc

Gets the background color for the widget.

Specified by:

getBackColor in interface GralWidget_ifc

Parameters:

ix - 0 if only one color is supported, 1, ... if the widget has more as one background.

Returns:

color Any color

setLineColor

public void setLineColor(GralColor color,
                         int ix)

Description copied from interface: GralWidget_ifc

Sets the line color for the widget.

Specified by:

setLineColor in interface GralWidget_ifc

Parameters:

color - Any color

ix - 0 if only one color is supported, 1, ... if the widget has more as one line.

setTextColor

public void setTextColor(GralColor color)

Description copied from interface: GralWidget_ifc

Sets the text color for the widget.

Specified by:

setTextColor in interface GralWidget_ifc

Parameters:

color - Any color

setText

public void setText(java.lang.CharSequence text)

Description copied from interface: GralWidget_ifc

Set the text of the widget. If the widget is a button, the standard button text is changed. If it is a window, its title is changed.

Concept of changing a widget from application:
Here the generally approach is described, appropriate for this method, but in the same kind for all methods to set something like GralWidget_ifc.setBackColor(GralColor, int) etc.

With the set methods the user stores the text, color etc. in graphic-independent attributes. Then the method GralWidget_ifc.redraw(int, int) is invoked with the standard delay of #redrawtDelay and #redrawDelayMax. With that the widget-specific private instance of #repaintRequ is added to the queue of requests in the GralGraphicThread#addTimeEntry(GralGraphicOrder). In the requested time that dispatch order is executed in the graphic thread. It calls GralWidgImplAccess_ifc.redrawGthread(). That method is implemented in the graphic implementation layer of the widget. It sets the appropriate values from the independent Gral attributes to the implementation specifics and invoke a redraw of the graphic layer.

If more as one attribute is changed one after another, only one instance of the GralGraphicOrder is queued. All changed attributes are stored in DynamicData#whatIsChanged and the GralWidgImplAccess_ifc.redrawGthread() quests all changes one after another. It means that a thread switch is invoked only one time per widget for more as one change.
See DynamicData. That composite part of a widget stores all standard dynamic data of a widget.

Specified by:

setText in interface GralWidget_ifc

setHtmlHelp

public void setHtmlHelp(java.lang.String url)

Description copied from interface: GralWidget_ifc

Sets the html help url for this widget. That information will be used if the widget is focused to control the help window output.

Specified by:

setHtmlHelp in interface GralWidget_ifc

Parameters:

url - String given url, maybe a local file too with #internalLabel.

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:

redraw

public void redraw()

Description copied from interface: GralWidget_ifc

repaint request. It can be called in any thread. If it is called in the graphic thread, the repaint action is executed immediately in the thread. Elsewhere the graphic thread will be waken up in the standard repaint time (about 100 ms). If this routine is invoked more as one time before the standard repaint time expires and not in the graphic thread, then the repaint is executed only one time after the given delay with the last set data. See GralWidget_ifc.redraw(int, int)

Specified by:

redraw in interface GralWidget_ifc

redraw

public void redraw(int delay,
                   int latest)

Description copied from interface: GralWidget_ifc

Possible delayed repaint, can be called in any thread. If this method is re-called in the time where the delay is not elapsed then the delay will be set newly, the timer is winding up again. But the latest time on first call will be used.

Specified by:

redraw in interface GralWidget_ifc

Parameters:

delay - in milliseconds. If 0 or less 0, then it is executed immediately if the calling thread is the graphic thread.

latest - The latest draw time in milliseconds. If it is <= 0, then it is unused. Note that a new call of repaint removes an existing repaint order to the new given time. With the latest argument for this time the repaint is always executing independent of new calls.

setBoundsPixel

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

Description copied from interface: GralWidget_ifc

This operation is used if the pixel are calculated on gral level. Intrinsic this operation is not system-conform, instead use grid units here. TODO look where it is used.

Specified by:

setBoundsPixel in interface GralWidget_ifc

setDataPath

public void setDataPath(java.lang.String sDataPath)

Description copied from interface: GralWidget_ifc

Sets the data path. It is a String in application context. If variables are used, it is the path of one or more variables, see GralWidget_ifc.refreshFromVariable(VariableContainer_ifc).

Specified by:

setDataPath in interface GralWidget_ifc

isChanged

public boolean isChanged(boolean setUnchanged)

Description copied from interface: GralWidget_ifc

Returns true if the content is changed from a user action on GUI.

Specified by:

isChanged in interface GralWidget_ifc

Parameters:

setUnchanged - If true then set to unchanged with this call.

Returns:

true if the content was changed since last setUnchanged.

setContentIdent

public long setContentIdent(long ident)

Description copied from interface: GralWidget_ifc

Sets a identification for the shown data. A widget may not need to refresh if the contentIdent is not changed. A refresh of a widget's content may have side effects in user handling such as selection of text etc. See GralWidget_ifc.getContentIdent().

Specified by:

setContentIdent in interface GralWidget_ifc

Parameters:

ident - any number which identifies the value of content.

Returns:

the last stored ident.

getContentIdent

public long getContentIdent()

Description copied from interface: GralWidget_ifc

Gets the content identification of the users data which are set with GralWidget_ifc.setContentIdent(long).

Specified by:

getContentIdent in interface GralWidget_ifc

getContentInfo

public java.lang.Object getContentInfo()

Specified by:

getContentInfo in interface GralWidget_ifc

refreshFromVariable

public void refreshFromVariable(VariableContainer_ifc container)

Description copied from interface: GralWidget_ifc

Capability for any widget to update its content from its associated variables described in its sDataPath.

Specified by:

refreshFromVariable in interface GralWidget_ifc

Parameters:

container - The container is used only if the variable is not known by direct reference in the private GralWidget.variable or GralWidget.variables. If the variable(s) is/are not known, they are searched by there data path set by GralWidget_ifc.setDataPath(String). More as one variables are possible separated by "," in the setDataPath("variable1, variable2"). The variables are searched in the container calling VariableContainer_ifc#getVariable(String).

refreshFromVariable

public void refreshFromVariable(VariableContainer_ifc container,
                                long timeAtleast,
                                GralColor colorRefreshed,
                                GralColor colorOld)

Description copied from interface: GralWidget_ifc

Capability of any widget for GralWidget_ifc.refreshFromVariable(VariableContainer_ifc) but additionally the widget is shown as "too old" if the time stored with the variable is old. This helps to show the state of fields for updating.

Specified by:

refreshFromVariable in interface GralWidget_ifc

timeAtleast - The absolute time stamp after them the variable should be gotten a new value. It may be for example some seconds before the current time.

colorRefreshed - show with this background color if refreshed

colorOld - show with this background color if not refresehed.

remove

public boolean remove()

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.

Specified by:

setFocusedWidget in interface GralWidgetBase_ifc

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.

Specified by:

getFocusedWidget in interface GralWidgetBase_ifc

getPanelWidget

public GralWidget getPanelWidget()

Specified by:

getPanelWidget in interface GralPanel_ifc

getWidgetList

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

Specified by:

getWidgetList in interface GralPanel_ifc

pos

public GralPos pos()

Description copied from interface: GralWidgetBase_ifc

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 GralPanel_ifc

Specified by:

pos in interface GralWidgetBase_ifc

Returns:

the position, always available, never null.

canvas

public GralCanvasStorage canvas()

Specified by:

canvas in interface GralPanel_ifc

removeWidget

public void removeWidget(GralWidget widg)

Description copied from interface: GralPanel_ifc

Only used internally

Specified by:

removeWidget in interface GralPanel_ifc

getImplWidget

public java.lang.Object getImplWidget()

Description copied from interface: GralWidget_ifc

Returns the implementation widget or its Wrapper. Need cast due to implementation level.

Specified by:

getImplWidget in interface GralWidget_ifc

Returns:

null if implementation is not existing.