org.vishia.gral.base

Class GralArea9Panel

java.lang.Object

org.vishia.gral.base.GralWidgetBase

org.vishia.gral.base.GralWidget

org.vishia.gral.base.GralPanelContent

org.vishia.gral.base.GralArea9Panel

All Implemented Interfaces:

GetGralWidget_ifc, GralPanel_ifc, GralSetValue_ifc, GralVisibleWidgets_ifc, GralWidget_ifc, GralWidgetBase_ifc

public class GralArea9Panel
extends GralPanelContent

This is a special panel, enhances the GralPanelContent, with up to 9 areas for other panels or widgets.

 +=======+===============+===========+
 |  A1   |       A2      |    A3     | 
 +-------+---------------+-----------+ 
 |  B1   |       B2      |    B3     | 
 |       |               |           | 
 +-------+---------------+-----------+ 
 |  C1   |       C2      |    C3     | 
 |       |               |           | 
 +=======+===============+===========+
 

The areas can be combined for one widget (usual a GralTextBox or a sub panel) for example in the form:

 +=======+===========================+
 |       |                           | 
 | tree  |     edit area,            | 
 | view  |     tables, etc           | 
 |       |                           | 
 +-------+---------------------------+ 
 |    output console text            | 
 |                                   | 
 +=======+===============+===========+
 

The separation lines between the areas are movable with mouse.
To place widgets the GralPos for contents should be set with "@area9,A1A2" for example for the tree view area. or alternatively (here for the edit area) via pos.setPositionSize(0, 1, 2, 2, 'r', pos) with numeric values 0..2 for the areas.

Nested Class Summary

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

GralPanelContent.Data, 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
static int	version Version, history and license.
private short[]	xMaxGralSize requested maximal size of each window area in GralPos units.
private short[]	xMinGralSize requested minimal size of each window area in GralPos units.
protected short[]	xpFrameArea Position of the FrameArea borders in percent
private short[]	yMaxGralSize requested maximal size of each window area in GralPos units.
private short[]	yMinGralSize requested minimal size of each window area in GralPos units.
protected short[]	ypFrameArea Position of the FrameArea borders in percent

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

_panel

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
GralArea9Panel(GralPos refPos, java.lang.String posName)

Method Summary

Modifier and Type	Method and Description
protected GralRectangle	convertArea(java.lang.String area) Converts a string given are designation to indices.
void	setFrameAreaBorders(int x1p, int x2p, int xRange, int y1p, int y2p, int yRange) Sets the divisions of the frame.
void	setMinMaxSizeArea(java.lang.String sArea, int yMinUnit, int yMaxUnit, int xMinUnit, int xMaxUnit) Sets a Component into a defined area.
protected void	validateFrameAreas() Set the bounds of all areas.
void	XXXaddFrameArea(java.lang.String sArea, GralWidget component)

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

addTabPanel, canvas, getCreateCanvas, getFocusedWidget, getPanelWidget, getTextFrom, getWidget, getWidgetImplementation, getWidgetList, getWidgetsToResize, getWidgetsVisible, isTabbed, remove, removeWidget, removeWidget, reportAllContent, setFocusedWidget, setGrid, setPanelVisible, setTextIn, setToTabbedPanel, toString, widgetList, XXXsetFocusGThread

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 int version

Version, history and license.

• 2022-11-12 created following the concept idea of the older org.vishia.gral.area9.GralArea9MainCmd. The last one should be removed in future.
  Why this is better:
  • This class can used whenever a panel with areas are necessary also as sub panel, not only for the whole window.
  • The GralArea9MainCmd is over-engineered, contains to much, especially the older org.vishia.mainCmd.MainCmd which was one of the first ideas in my Java programming.
  This GralArea9Panel is more simple and lightweight.

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

xpFrameArea

protected short[] xpFrameArea

Position of the FrameArea borders in percent. [0] is always 0, [1] and [2] are the given borders, [3] is always 100. It is because lower and higher bound should be accessed always without tests. Use area +1, because it is a Off-by-one problem

ypFrameArea

protected short[] ypFrameArea

Position of the FrameArea borders in percent. [0] is always 0, [1] and [2] are the given borders, [3] is always 100. It is because lower and higher bound should be accessed always without tests. Use area +1, because it is a Off-by-one problem

xMinGralSize

private final short[] xMinGralSize

requested minimal size of each window area in GralPos units. If the minimal value is 0, the size is calculated from percent always. If the minimal value of percent calculation is lesser than this value, this value is used. Note that a given minimal value of all areas cannot required if the window's size is lesser. Then the middle area will

yMinGralSize

private final short[] yMinGralSize

requested minimal size of each window area in GralPos units. If the minimal value is 0, the size is calculated from percent always. If the minimal value of percent calculation is lesser than this value, this value is used. Note that a given minimal value of all areas cannot required if the window's size is lesser. Then the middle area will

xMaxGralSize

private final short[] xMaxGralSize

requested maximal size of each window area in GralPos units. If the maximal value is greater than the size calculated from percent always, the percent value is used. Note that a given maximal value of all areas cannot regarded if the window's size is greater. Then the middle area will be presented

yMaxGralSize

private final short[] yMaxGralSize

requested maximal size of each window area in GralPos units. If the maximal value is greater than the size calculated from percent always, the percent value is used. Note that a given maximal value of all areas cannot regarded if the window's size is greater. Then the middle area will be presented

Constructor Detail

GralArea9Panel

public GralArea9Panel(GralPos refPos,
                      java.lang.String posName)

Method Detail

setFrameAreaBorders

public void setFrameAreaBorders(int x1p,
                                int x2p,
                                int xRange,
                                int y1p,
                                int y2p,
                                int yRange)

Sets the divisions of the frame. The frame is divide into 9 parts, where two horizontal and two vertical lines built them:

 +=======+===============+===========+
 |  A1   |       B1      |    C1     | 
 +-------+---------------+-----------+ 
 |  A1   |       B2      |    C2     | 
 |       |               |           | 
 +-------+---------------+-----------+ 
 |  A3   |       B3      |    C3     | 
 |       |               |           | 
 +=======+===============+===========+
 

Parameters:

x1p - percent from left for first vertical divide line.

x2p - percent from left for second vertical divide line.

y1p - percent from left for first horizontal divide line.

y2p - percent from left for first horizontal divide line.

XXXaddFrameArea

public void XXXaddFrameArea(java.lang.String sArea,
                            GralWidget component)

setMinMaxSizeArea

public void setMinMaxSizeArea(java.lang.String sArea,
                              int yMinUnit,
                              int yMaxUnit,
                              int xMinUnit,
                              int xMaxUnit)
                       throws java.lang.IndexOutOfBoundsException

Sets a Component into a defined area. See #setFrameAreaBorders(int, int, int, int). It should be called only in the GUI-Thread.

Parameters:

xArea - 1 to 3 for left, middle, right

yArea - 1 to 3 for top, middle, bottom

dxArea - 1 to 3 for 1 field to 3 fields to right.

dyArea - 1 to 3 for 1 field to 3 field to bottom

component - The component.

Throws:

java.lang.IndexOutOfBoundsException - if the arguments are false or the area is occupied already.

validateFrameAreas

protected void validateFrameAreas()

Set the bounds of all areas. Calls GralWindow.getPixelPositionSize() to get the size of working area of the whole window

convertArea

protected GralRectangle convertArea(java.lang.String area)

Converts a string given are designation to indices.

Parameters:

area - A, B , C for column, 1, 2, 3 for row. Write "A1" or "1A" for a one-area rectangle, or "A1C2" or also "1A2C" for a comprehensive area.

Returns:

Rectangle describes the usage of the area, it contains indices from 1..3.