org.vishia.gral.swt

Class SwtSubWindow

java.lang.Object

org.vishia.gral.base.GralWidget.ImplAccess

org.vishia.gral.base.GralWindow.WindowImplAccess

org.vishia.gral.swt.SwtSubWindow

All Implemented Interfaces:

GralWidgImplAccess_ifc

public class SwtSubWindow
extends GralWindow.WindowImplAccess
implements GralWidgImplAccess_ifc

The SwtSubWindow is the wrapper arroung a Shell to implement a GralWindow. The following inheritance structure is given (hint: only readable in Javadoc, not in src, because of length of link controls

 SwtSubWindow<>-->SwtPanel<>-->GralPanelContent.ImplAccess<>-->GralWidget.ImplAccess
                   |                                    |
                   +<*>-->SwtPanel#swtGralWindow        +<*>---------------------------------------+
                            |                                                                      ,
                            +<*>-->GralWindow.WindowImplAccess#gralWindow : GralWindow<>-->GralPanelContent<>-->GralWidget
                                     ^
   SwtWindowImplAccess<>-------------+
   
 SwtSubWindow<>--->SwtPanel<>--->GralPanelContent.ImplAccess<>---->GralWidget.ImplAccess
  |                 |                              |                               +-widgg-->GralWindow<>-->GralWidget
  |                 |                              +-widgg : GralPanelContent      +-wdgimpl-->GralWidgetImpl_ifc<>-+
  |                 +-panelComposite--->
  |                 +-tabFolder : TabFolder
  |                 +-itsTabSwt : TabItem
  |
  +-swtWidgWrapper--------------->SwtWidgetHelper<------------------------------------------------------------------
  +-window-->swt.Shell<>-->Control<--widgetSwt-+ 
  +-swtPanel--->SwtPanel
  +-menuBar--->SwtMenu
 

To access the GralWindow.WindowImplAccess#gralWindow you should use the aggregation SwtPanel#swtGralWindow from the SwtPanel super class.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) class	SwtSubWindow.ActionUserMenuItem

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	bFullScreen State of the window in swt.
private boolean	bHasMouseAction Some flags to set an action listener a first time if the action is given.
private DisposeListener	disposeListener
private DisposeListener	disposeListenerMainWindow
protected SwtMenu	menuBar
(package private) MouseListener	mouseListener The mouseListener will be activated if GralWindow.setMouseAction(GralUserAction) will be called.
private ControlListener	resizeListener The resizeListener is always associated to the Shell (Swt Window).
protected ShellListener	shellListener
static java.lang.String	sVersion Version, history and license: 2016-08-31 Hartmut chg: Now disposes the window in shellListener 2015-05-31 Hartmut setFocusGThread() now regards the GralPanelContent#setFocusedWidget(GralWidget).
(package private) SwtWidgetHelper	swtWidgWrapper It contains the association to the swt widget (Control) and the SwtMng and implements some methods of GralWidgImplAccess_ifc which are delegate from this.
protected Shell	window
protected PaintListener	windowPaintListener

Fields inherited from class org.vishia.gral.base.GralWindow.WindowImplAccess

gralWindow

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

bRedrawOnlyDynamics, chgBitsDerived, chgColorBack, chgColorLine, chgColorText, chgCurrTab, chgEditable, chgFloat, chgFocus, chgFont, chgIntg, chgInvisible, chgObjects, chgPos, chgText, chgVisible, chgVisibleInfo, mngImpl, pixBounds, wdgimpl, widgg

Fields inherited from interface org.vishia.gral.base.GralWidgImplAccess_ifc

version

Constructor Summary

Constructors

Constructor and Description
SwtSubWindow(SwtMng mng, GralWindow gralWindow) Constructs a window (primary or sub window maybe for dialog etc.).

Method Summary

Modifier and Type	Method and Description
GralRectangle	getPixelPositionSize()
java.lang.Object	getWidgetImplementation() The Swt widget implementation is either the Shell itself which is a Composite, or it is the TabFolder, which is created as only one Composite inside this shell composite.
void	redrawGthread() This method should be implemented in all Widget implementations of the adapter for the underlying graphic system.
void	removeWidgetImplementation() Removes the graphical widget in the graphic.
void	reportAllContentImpl(java.lang.Appendable out) Reports the tree of content of the window from view of swt Composite#getChildren()
protected void	resizeWindow()
void	setBoundsPixel(int x, int y, int dx, int dy) Returns the size of the working area without border, menu and title of the window.
boolean	setFocusGThread() Sets the focus to the widget.
void	setVisibleGThread(boolean bVisible) Sets the implementation widget(s) visible state.
(package private) void	stop()
void	updateValuesForAction() This operation should be called before any action is invoked in the user space.

Methods inherited from class org.vishia.gral.base.GralWindow.WindowImplAccess

actionOnCloseWindow, getMenubar, getTitle, getWindowProps, isFullScreen, mouseAction, resizeWidgets, shouldClose

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

acknChanged, actionShow, dyda, getActionChange, getChanged, gralMng, gralWidgetFromImplData, redrawOnlyDynamics, setDragEnable, setDropEnable, setPosBounds, setTextChanged, setVisibleState, XXXfocusGained

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.vishia.gral.base.GralWidgImplAccess_ifc

setPosBounds

Field Detail

sVersion

public static final java.lang.String sVersion

Version, history and license:

• 2016-08-31 Hartmut chg: Now disposes the window in shellListener
• 2015-05-31 Hartmut setFocusGThread() now regards the GralPanelContent#setFocusedWidget(GralWidget).
• 2015-04-27 Hartmut new GralWindow_ifc.windRemoveOnClose
• 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-06-29 Hartmut new: #setResizeAction(GralUserAction) now for both ctors, resize on subwindow works.
• 2012-03-10 Hartmut new: calls invisibleSetAction.userActionGui if the window is set invisible by pressing the X closing icon.
• 2012-02-11 Hartmut chg: The menu of the window is managed now in SwtMenu. Instance refered with menuBar
• 2011-11-27 Hartmut chg: #addMenuBarArea9ItemGThread(String, String, GralUserAction) moved from SwtPrimaryWindow to this, because the capability to have a menu bar may needed on a sub-window too.
• 2011-11-18 Hartmut chg: SwtSubWindow#SwtSubWindow(String, Display, String, int, GralMng) now gets an int-property instead boolean 'exclusive'. A window has more as one property. Constants are defined in GralWindow_ifc.windExclusive etc.
• 2011-11-10 Hartmut chg: move all files from mainGuiSwt to gral.swt, dissolve of package mainGuiSwt
• 2011-11-09 Hartmut chg: renamed from SubWindowSwt to SwtSubWindow
• 2011-11-01 Hartmut new: shellListener and disposeListener added, but empty yet.
• 2011-10-31 Hartmut new: mouseListener and GralWindow.setMouseAction(GralUserAction).
• 2011-10-30 Hartmut new: resizeListener, #setResizeAction(GralUserAction) etc: Not this class is base of SwtPrimaryWindow and contains this capabilities yet.
• 2011-10-30 Hartmut new: getPixelPositionSize() and setBoundsPixel(int, int, int, int) to support pixel-orientation too. Note it isn't a concept of GRAL anyway, but it is needed.
• 2011-10-20 Hartmut chg: GralMng as parameter of constructor: The GralWidget refers it, it should be initialized.
• 2011-10-15 Hartmut new: removeWidgetImplementation().
• 2011-09-23 Hartmut bugfix: setFocus() called in GralWindow.setWindowVisible(boolean), it hasn't the focus automatically.
• 2011-09-18 Hartmut chg: Now it is a SubWindowSwt and inherits from the new GralWindow. Some methods GralWidget.setBackColor(GralColor, int), GralWindow.setWindowVisible(boolean) etc added to comply the interface and super class definitions.
• 2011-09-03 Hartmut creation as wrapper arround a SWT.Shell inherits GralPanelContent.

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

swtWidgWrapper

SwtWidgetHelper swtWidgWrapper

It contains the association to the swt widget (Control) and the SwtMng and implements some methods of GralWidgImplAccess_ifc which are delegate from this.

window

protected Shell window

menuBar

protected SwtMenu menuBar

bFullScreen

protected boolean bFullScreen

State of the window in swt.

bHasMouseAction

private boolean bHasMouseAction

Some flags to set an action listener a first time if the action is given.

windowPaintListener

protected PaintListener windowPaintListener

shellListener

protected ShellListener shellListener

disposeListener

private final DisposeListener disposeListener

disposeListenerMainWindow

private final DisposeListener disposeListenerMainWindow

mouseListener

MouseListener mouseListener

The mouseListener will be activated if GralWindow.setMouseAction(GralUserAction) will be called. It calls this user action on resize.

resizeListener

private final ControlListener resizeListener

The resizeListener is always associated to the Shell (Swt Window). It calls GralWindow.WindowImplAccess.resizeWidgets(GralRectangle) with the client area of the window. This calls via GralWidgetBase.GralWidgComposite#resizeWidgets(GralRectangle, int) the necessary setBounds() for all members, without any other resizeListener of components.
Any widget can have a user defined resize action, that is GralWidgetBase.resizePostPreparation(). That is called from GralWidgetBase.GralWidgComposite#resizeWidgets(GralRectangle, int) from the window down to all widgets. History: 2023-04 resize actions were removed. before 2022-09 this action does the resizing itself.

Constructor Detail

SwtSubWindow

SwtSubWindow(SwtMng mng,
             GralWindow gralWindow)

Constructs a window (primary or sub window maybe for dialog etc.).

Parameters:

name -

display -

title -

windProps -

gralMng -

Throws:

java.io.IOException

Method Detail

getWidgetImplementation

public java.lang.Object getWidgetImplementation()

The Swt widget implementation is either the Shell itself which is a Composite, or it is the TabFolder, which is created as only one Composite inside this shell composite. Both are referenced via the abstraction class SwtPanel.panelSwtImpl.

Specified by:

getWidgetImplementation in interface GralWidgImplAccess_ifc

Overrides:

getWidgetImplementation in class GralWidget.ImplAccess

removeWidgetImplementation

public void removeWidgetImplementation()

Description copied from interface: GralWidgImplAccess_ifc

Removes the graphical widget in the graphic.

Specified by:

removeWidgetImplementation in interface GralWidgImplAccess_ifc

getPixelPositionSize

public GralRectangle getPixelPositionSize()

Specified by:

getPixelPositionSize in interface GralWidgImplAccess_ifc

setBoundsPixel

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

Returns the size of the working area without border, menu and title of the window. Uses org.eclipse.swt.widgets.Scrollable#getClientArea() to get the size.

Specified by:

setBoundsPixel in interface GralWidgImplAccess_ifc

stop

void stop()

setFocusGThread

public boolean setFocusGThread()

Description copied from interface: GralWidgImplAccess_ifc

Sets the focus to the widget. See GralMng_ifc#setFocus(GralWidget).

Specified by:

setFocusGThread in interface GralWidgImplAccess_ifc

Returns:

true if it has the focus after this operation. false on any error.

setVisibleGThread

public void setVisibleGThread(boolean bVisible)

Description copied from interface: GralWidgImplAccess_ifc

Sets the implementation widget(s) visible state. The widgets are really invisible, or they are visible in principle, but they can be covered by other windows or clipping. This method should set the GralWidgetBase.bVisibleState too. Therewith it is able to quest GralWidget.isVisible() in any thread.

Specified by:

setVisibleGThread in interface GralWidgImplAccess_ifc

Parameters:

bVisible - true then the widget should be visible, false it is set to invisible.

redrawGthread

public void redrawGthread()

Description copied from interface: GralWidgImplAccess_ifc

This method should be implemented in all Widget implementations of the adapter for the underlying graphic system.
Implementation hints: In SWT it should call redraw(). In AWT this is named 'repaint()'-
It is possible that the widget consists of more as one graphical widget, then all of it should be redrawn. It is possible that some data are set in another thread, they should be applied to the widgets firstly. It is possible that the widget is removed though a repaintGthread-order is pending from the time before deleting, for example if the graphic layout is changed.

See #repaintRequ

Specified by:

redrawGthread in interface GralWidgImplAccess_ifc

updateValuesForAction

public void updateValuesForAction()

Description copied from interface: GralWidgImplAccess_ifc

This operation should be called before any action is invoked in the user space. It should update all values from the implementation widget to the GralWidget to enable getting it in the action.

Specified by:

updateValuesForAction in interface GralWidgImplAccess_ifc

resizeWindow

protected void resizeWindow()

reportAllContentImpl

public void reportAllContentImpl(java.lang.Appendable out)
                          throws java.io.IOException

Reports the tree of content of the window from view of swt Composite#getChildren()

Specified by:

reportAllContentImpl in class GralWindow.WindowImplAccess

Parameters:

out -

Throws:

java.io.IOException