org.vishia.gral.ifc

Interface GralWidgetBase_ifc

All Known Subinterfaces:

GralCurveView_ifc, GralPanel_ifc, GralTable_ifc<UserData>, GralTableLine_ifc<UserData>, GralTextBox_ifc, GralTextField_ifc, GralWidget_ifc, GralWindow_ifc

All Known Implementing Classes:

FcmdFileCard, FcmdLeftMidRightPanel.FcmdFavorThemeCard, GralArea9Panel, GralButton, GralCanvasArea, GralCommandSelector, GralCurveView, GralFileProperties, GralFileSelector, GralFileSelector.FileSelectList, GralHorizontalSelector, GralHtmlBox, GralInfoBox, GralLabel, GralLed, GralPanelContent, GralScreen, GralSelectList, GralSlider, GralSwitchButton, GralTable, GralTable.TableLineData, GralTextBox, GralTextField, GralValueBar, GralViewFileContent, GralWidget, GralWidgetBase, GralWindow

public interface GralWidgetBase_ifc

This is the basic interface of all widgets. It is especially important for comprehensive widgets which are not derived from GralWidget but only from GralWidgetBase. Especially the GralPos.parent uses this type, because all widgets can be the parent.

Method Summary

Modifier and Type	Method and Description
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.String	getName() Access to the name of the widget.
GralMng	gralMng() Returns the associated GralMng.
boolean	isInFocus() Returns true if this widget is the focused one.
boolean	isVisible() Returns whether the widget is visible or not.
GralPos	pos() Position of the widget, which refers also the GralPos.parent.
void	setFocus() Sets the focus to the widget. .
void	setFocus(int delay, int latest)
void	setFocused(boolean bGained) This operation can be called from the implementation graphic if the focus is gained or lost 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.
boolean	setVisible(boolean visible) Sets this widget visible on graphic or invisible.

Method Detail

getName

java.lang.String getName()

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

Returns:

the name

pos

GralPos pos()

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

Returns:

the position, always available, never null.

setFocus

void setFocus()

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.

setFocus

void setFocus(int delay,
              int latest)

isInFocus

boolean isInFocus()

Returns true if this widget is the focused one.

setVisible

boolean setVisible(boolean visible)

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.

Parameters:

visible -

Returns:

isVisible

boolean isVisible()

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.

Returns:

true if the widget seams to be visible.

setFocusedWidget

void setFocusedWidget(GralWidgetBase_ifc widg)

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

GralWidgetBase_ifc getFocusedWidget()

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.

setFocused

void setFocused(boolean bGained)

This operation can be called from the implementation graphic if the focus is gained or lost for an implementation widget. It is also called from the default implementation in GralWidgetBase.setFocused(boolean) for all parents of a widget if a child gets or lost 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.

Parameters:

bGained - false then lost.

gralMng

GralMng gralMng()

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

getImplAccess

GralWidget.ImplAccess getImplAccess()

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.

Returns: