org.vishia.gral.base

Class GralPos

java.lang.Object

org.vishia.gral.base.GralPos

All Implemented Interfaces:

java.lang.Cloneable

public class GralPos
extends java.lang.Object
implements java.lang.Cloneable

This class describes a position in a gral panel.

Concept of positioning:
The position are never given as pixel positions. They are user-oriented positions. The calculation of pixel units are done from the implementing graphic layer depending on the graphic device properties and the requested size appearance. The same graphic elements can be presented in several sizes on the display.

A normal text with a font in the standard proper read-able size is presented by 2 units of the Gral-position in vertical direction (line) and approximately 1 unit per character in horizontal direction. Of course the horizontal character size depends on the font properties. A text can be presented in a smaller or larger font. The text height depends on the height given in the position of the text. A very small font is presented by 1 vertical gral-unit. Such a text can be used as short title for text input fields (prompt) or adequate.
A button is able to proper present with 3 or 2 vertical gral units. A small check box may be presented with 1 x 1 gral unit.

A gral unit should be have the same distance in vertical as in horizontal direction. It depends on the graphical implementation. One gral unit may have approximately 6 to 30 pixel, depending on the requested size of appearance in comparison with the given display pixel size. Any graphic can be shown in several sizes of appearance, given with a start parameter of the application (see org.vishia.gral.area9.GuiCallingArgs#sSize) respectively the parameter size of GralGridProperties#GralGridProperties(char size).

Fine positions:
Either the positions are given as float value. Then the intger part (left from dot) is the grid position itself, as grid unit, described above. One digit after dot as fractional part is the fine position or fine grid unit, described following.
If positions are given as integer values, the value is grid unit * 10 + fine grid unit. The fine grid unit is in range 0..9.

The fine grid units divides one Gral grid position into 5 or into 6 fine positions. The odd numbers divide into 6 positions. In this kind a Gral grid position is able to divide by 2, 3 and 6:

• 1: 1/6 = 0.1333
• 3: 1/3 = 0.3333
• 5: 1/2 = 0.5
• 7: 2/3 = 0.6667
• 9: 5/6 = 0.8667

The even numbers divide into 5 positions:

• 2: 1/5 = 0.2
• 4: 2/5 = 0.4
• 6: 3/5 = 0.6
• 8: 4/5 = 0.8

The fine positioning enables a fine positioning of widgets in respect to the fundamental positions.

Bit designations for the stored numeric values of the position in this class:
Though the position arguments to set a position may be given relative to other ones as samesize, size, same, next and refer, the position values are stored as absolute positions anyway. That are the elements x, and y with its values in GralPos.Coordinate. The GralPos.Coordinate.p1 is the lesser value, left and top, and GralPos.Coordinate.p2,the end position is the greater value, right or bottom.
If the values are (10 * grid units + fine unit) if they are not designated as ratio or useNatSize. A negative value, counts from the given spread in the parent from bottom or right side.
The GralPos.Coordinate.p1 is used for left or top and GralPos.Coordinate.p2 is used for right and bottom. The pixel values (calculated with #calcWidgetPosAndSize(GralGridProperties, int, int, int, int)) uses the known height and width from the parent if the implementation graphic is active. It depends from resizing actions. If then the left or top pixel value is greater then the right or bottom pixel value because left or top is given as positive value and the other is given negative (from bottom or right) and the size is too less, it is calculated in this kind, and the widget may be invisible or an position error may occur. This is a result of a bad given positioning.
This form of storing is better to calculate the pixel position while building the graphic and it is better to calculate related position too.
Generally the stored numeric value is integer in range 0x8001 .. 0x7fff for the position itself. This means a grid range of 6400 which is proper for display sized of more as 30000 pixel.
For specific calculations some mask bits can be added:

• An additional value useNatSize means, the position is given as pixel units. This is only usable for images which should not be scaled.
• An additional value ratio means, the position value in range 0..1000 is related to the spread of the parent as ratio. This feature is still TODO. It is important for resize.

Positions as numeric arguments: The designations ratio and 786432 can be immediately used too for setting the positions. Additional some more designations are possible, which calculates the position to store from other given stored positions:

• Without designation the numeric value is the absolute values of grid units + fine grid units regarded to the spread of the parent panel or comprehensive widget. Whereas negative numbers counts from bottom or right side. The 0 for end position is the bottom or right of the #parent.
  The numeric values must be in range -1600.0 till 1600.0 as float or adequate -16000 ... 16000 (more exact 0xc001..0x3fff). This is enough for display pixel sizes till ranges of 10000. The real possible range is 16 bit, 0x8001..0x7fff.
• The value same (without additional value!) means, using the same position value as the reference position (given as 'refPos' in the setPosition...(...) operations. If the refPos is null, it means don't change this value.
• The value next (without additional value!) for the left and top position means, calculate this positions from the refPos with the given direction and border in GralPos.Coordinate.pb. If the direction in GralPos.Coordinate.dirNext is 'l' or 'r' for the x position or 'u' or 'd' for the y position, then this position is incremented. The other position is not incremented, because the same value for dirNext is stored there. Hence 'd' increments the y. GralPos.Coordinate.p1 but not the x.
• An additional value refer (0x80000) means, the position is related to the given refPos, or the yet given own position if refPos = null. Of course the additional calculated position should not exceed the range of 0x8000 ... 0x7fff respectively should be inside the viewable spread. It means the additional value is usual in a small range + or - 1..100.0f or 1..1000 for integer presentation.
• An additional value size for the right and bottom coordinate means, the value is added to the value of left or top. It is given as size. Whereby a negative size means, the position as first argument is the bottom or right position, the top or left position is calculated with the size. For example calling setPosition(null, 10.0f, -3.5f + GralPos.size, 20, 12 + GralPos.size) means, the absolute postion is 6.5..10 in y direction and 20..32 in x direction.
• The value samesize (without additional value!) means, the end values are calculated using the size of the refPos or the given size before of the own positions if refPos = null. For example For example calling setPosition(null, 4 + GralPos.refer, GralPos.samesize, 20, 12 + GralPos.size) means, that on given position in y 6.5..10 the new position is 10.5..14.
• The additional value areaNr is only usable for the GralArea9Panel as selection for the sub panel.

Fine positions are given always from left or top of the fundamental positions. For example a value -1.3 means, the widget is placed 1 unit from right, and then 1/3 inside this unit. This is 2/3 unit from right. A value for example -0.3 is not admissible, because -0 is not defined.

Position writing style in a gral script:
The appearance of a graphic can be given with a script using GralCfgZbnf. The writing style of positions in the script regards a stinting short style to give positions, because a hand written script should not cause a lot of calculations for positions by the writer. It should be simple. The syntax of a position in the gral script is given in the variable syntaxZbnf. The method setPosition(CharSequence, GralPos) uses that syntax.

• @myPanel, 5..7, 8..18: This is a full given absolute position. The element should be placed from line 5 to line 7 and from column 8 to 18. The vertical position 7 is the bottom line, the column 18 is the right column exclusive. The horizontal size is 10, the vertical size is 2.
• @myPanel, 5..7, 8..-1: This is a full given absolute position. The end column is given with a negative value. It means that the end column is related to the right border of the panel.
• @myPanel, 5+2, 8+10: This is a full given position using the size. The element should be placed from line 5 to line 7 and from column 8 to 18. The range is given as size.
• @7-2, 18-10: The panel isn't given, so the panel of the last position, in the script in order of text, is used. The positions are exactly the same, from 5 to 7 and from 10 to 18. But because the size is given as negative value, the position value is the bottom line and the right column. A user may place elements with a common bottom line. The this form can be used.
• @7-2, 10+18++1: This is the same position too. The '++' operator after size means, that the next element is positioning right side after the current in distance of 1 unit (distance feature TODO).
• @-3,+4: The position isn't given yet. It means, the position of the last element is used. Because the size is negative, the bottom position of the last element is used. Because the last position is designated with '++' for column, the column value of position is the right value and the current element is placed right hand from the last one. This is an example of a button right from a text. The button is some times greater (3 units) in relation to the text (2 units), but they have the same button line.
• @,+5: Here the line isn't specified. It is taken from the last position: bottom line 7 and height 3. The column isn't given, it is taken form the last: Because the column position is cumulated, it is the 22 yet.
• If no position is given, the position is the next position. In this example @7-3,27+5.
• @,+2+10: The '+' on the first value determines a relative position related to the last one. In this example the new column is 24 to 34. There is 2 units space.
• @ +-2-2,+0+20: A negative relative position related to the last absolute given position should be written firstly with the '+' to prevent confusion with the '-' designation for counting from bottom or right side. In this example it is line 7 and column 10. The new position is calculated with that values to line 9. The column 10 is the same column related to the last given absolute. This kind of specification allows determining some positions in lines and columns, whereby the absolute position is given only one time. (feature TODO)
• @ %50-2,%10..%90: The positions are calculated from the size of the panel in percent. (feature TODO)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GralPos.Coordinate Class holds values for either x or y.

Field Summary

Fields

Modifier and Type	Field and Description
static int	areaNr Values 0ex001..0xe003 as number of a GralArea9Panel A..C for columns, 1..3 for rows
boolean	dbg
static int	invalidPos 0xdffff Marker for invalid, to check
private static int	kSpecialType Bit masks for the special types next, nextBlock, useNatSize.
private static int	kTypAdd_ Bits in an integer position value for the type.
private static int	mSpecialType Bit masks for the special types next, nextBlock, useNatSize.
private static int	mType_ Bits in an integer position value for the type.
private static int	mValueNegative Bits in an integer position value for range and size.
private static int	mValueRange_ Bits in an integer position value for range and size.
static int	next Use the next value for the coordinate in relation to the last one for the given direction but the same value for the other coordinate.
static int	nextBlock Use the next value for the coordinate in relation to the last one.
GralWidgetBase_ifc	parent Relation of x and y left and top to any separation line. 0 - relation to left and top border.
static int	ratio This mask 0xa... at all coordinates means, that the value is given as ratio from the size.
static int	refer This mask 0x8... applied at any coordinate parameter of any setPosition- method means, that the value is referred to the position of the previous or given position.
static int	same This value applied at any coordinate parameter of any setPosition- method means, that the value is the same as the previous or given position.
static int	samesize Use the same size.
static int	size This adding value at xEnd or yEnd or the float presentations of the calling argument of any setPosition- method means, that the value is the size, not the position.
static java.lang.String	syntaxZbnf Syntax of a position.
static int	useNatSize This value 0x0c000 at xEnd or yEnd means, that the native size of a widget should be used.
static java.lang.String	version Version, history and license.
GralPos.Coordinate	x The values for x and y positions.
private static int	XXXmCheckRatio_ Mask to check ratio.
private static int	XXXmNatSize_ Mask for value of natural size.
GralPos.Coordinate	y The values for x and y positions.

Constructor Summary

Constructors

Constructor and Description
GralPos(GralMng gralMng) Creates an position with all values 0 related to the whole screen.
GralPos(GralMng mng, java.lang.String pos)
GralPos(GralPos src) Creates a reference position from a given one.
GralPos(GralPos src, char direction) Creates a reference position from a given one but modifies the next direction before applying a position string.
GralPos(GralWidget_ifc panel, java.lang.String pos)
GralPos(GralWidgetBase_ifc parent) Set a initial GralPos with the given widget as parent.

Method Summary

Modifier and Type	Method and Description
static void	appendPos(java.lang.Appendable b, int p)
void	assertCorrectness()
GralPos	calcNextPos(java.lang.String posString) Deprecated. use setPosition(CharSequence)
GralRectangle	calcWidgetPosAndSize(GralGridProperties propertiesGui, GralRectangle parentPix, int widthWidgetNat, int heightWidgetNat) Calculates the position and size of a widget from this given Pos.
void	checkSetNext() This operation should be called before usage the position.
GralPos	clone() Creates a new position instance with the same values.
float	height() Returns the height in grid position + fine position as one digit after dot.
java.lang.String	posString() Returns the position in a syntax which is able to parse Useful to write back to a configuration file.
private void	scanPosition(StringPartScan spPos, GralPos.Coordinate co) Scans one coordinate.
GralPos	screenPos(int line, int col, int dy, int dx) Returns the position on the screen relative to the given pos Note: the from positions should be only >0 TODO
void	set(GralPos pos) Sets all values of this with the values of pos (copy values)
void	set10Position(int yPos, int ye, int xPos, int xe, char direction, int border, GralPos refPos) Sets the position for the next widget to add in the container.
GralPos	setAsFrame() Mark the position as frame position for some other derived positions.
void	setFinePosition(int line, int yPosf, int lineEndOrSize, int yef, int column, int xPosf, int columnEndOrSize, int xef, char direction, int border, int borderFrac, GralPos refPos) Deprecated. use set10Position(int, int, int, int, char, int, GralPos) for immediately replacement with 10*line + yPosf etc. or use setPosition(GralPos, float, float, float, float, char, float)
void	setFullPanel(GralPanelContent panel) Sets the position to the given full panel.
GralPos	setParent(GralWidgetBase_ifc parent) Sets a panel, maybe the GralMng.screen as parent for the widget, where this GralPos is used.
GralPos	setPosition(java.lang.CharSequence sPos) Set a new position in the same panel as given maybe relative to the own position.
void	setPosition(java.lang.CharSequence sPos, GralPos refPos) Sets the position with the given string representation.
void	setPosition(float line, float column)
void	setPosition(GralPos framePos, float line, float lineEndOrSize, float column, float columnEndOrSize) Sets the position
void	setPosition(GralPos refPos, float line, float lineEndOrSize, float column, float columnEndOrSize, char direction, float border) Sets the position with given grid coordinates in float.
void	setPositionSize(int line, int column, int height, int width, char direction, GralPos posFrame) Sets a position in full grid coordinates and the size in full grid values.
void	setSize(float height, float width, GralPos frame) Sets the position, direction as frame, but the size as given.
void	setUsed() Marks the position as used.
(package private) void	stop()
boolean	toResize() Returns true if this position is from right or bottom, so that a resize of the parent needs new positions for this widget.
java.lang.String	toString() Use especially for debug.
java.lang.StringBuilder	toString(java.lang.StringBuilder b, java.lang.String... appendPanel) Append position to given Appendable, for toString of using widgets.
float	width() Returns the width in grid position + fine position as one digit after dot.
float	xGrid()

Methods inherited from class java.lang.Object

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

Field Detail

version

public static final java.lang.String version

Version, history and license.

• 2023-08-14 new: GralPos(GralPos, char)
• 2023-04-16 chg: calcWidgetPosAndSize(GralGridProperties, GralRectangle, int, int) now uses GralRectangle for the parent. It is supported that the parent is any pixel region on the environment panel, not the whole panel. This is necessary for real GralWidgComposite without an own panel.
• 2023-01-30 chg: set10Position(int, int, int, int, char, int, GralPos) now instead setFinePositon(...), this is a explicitly different name to the old concept with two values for grid and fine grid position. Designation of some operations as deprecated, comment some stuff.
• 2023-01-03 chg: Now the origin parameter is removed. It is non sensible and never used for positions. Only for a text label it is sensible.
• 2022-12-30 meaningful refactoring. Now the positions are stored with fine grid units in only one number. This makes it more simple for relative calculation. The interpretation of the fractional part follows the direction of the integer value (of course). On the old solution the fractional part was oriented sometimes always to right and button, but that was confusing. Now it is even. See also test cases in test_vishiaGral/org/vishia/gral/test/basics/Test_GralPos.java
• 2022-12-20 Hartmut new screenPos(int, int, int, int) to get a pos relative to given widget but for another window.
• 2022-12-20 Hartmut chg parent can now be also a comprehensive widget, using GralWidgetBase_ifc.
• 2022-12-17 Hartmut new setAsFrame()
• 2022-11-20 showing Area9 positions, now ABC ar colomns not rows.
• 2022-11-20 Using ToStringBuilder for improved ToStringBuilder#toString(Appendable, String...)
• 2022-11-12 accepts also a GralWindow instead a GralPanel to replace the GralWindow.mainPanel
• 2022-11-11 accepts positions A1C3 for Area9
• 2022-10-27 new #calcWidgetPosAndSize(GralGridProperties) without more arguments. If necessary this operation gets sizes from the parent pos. But it needs more time.
• 2022-08 refactored. Now also for textual configured Widgets the setPosition(CharSequence, GralPos) is used. It means, should support all features. It is refactored and yet in test. Some bugfixes including, and more features.
• 2013-05-24 Hartmut bugfix fine position can be greater 20 if positions are add and sizes are add too.
• 2011-10-01 Hartmut corr: Calculation of next position or refer + value if the size was negative and sameSize is selected. Then the new input value should calculate from the bottom or left value because the size is negative furthermore.
• 2011-10-01 Hartmut bugfix: if(qf >= 10)... instead >10
• 2011-09-23 Hartmut chg: The methods #setPosition(GralPos, float, float, float, float, int, char) etc are moved from the GralGridMngBase to this. It are methods of this class functionally. The GralGridMngBase wrappes it because that methods should be able to call there.
• 2011-08-31 Hartmut new: constants same etc. as adding values for setPosition-methods. It prevents the necessity of a lot of special set methods. The parameter for positions may be relative, referred etc. to the previous position or to a frame.
• 2011-08-31 Hartmut new: method toString() to see values of instance in debug
• 2011-08-14 Hartmut new: creation of this class. Beforehand this values are stored inside the GralGridMngBase as main position. But a position in this kind is necessary in other contexts too, and the position values should be pooled in one class.

• 2011-06-00 Hartmut created

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

refer

public static final int refer

This mask 0x8... applied at any coordinate parameter of any setPosition- method means, that the value is referred to the position of the previous or given position. The referred value may be given as positive or negative number. Adding this constant a value in range 0x70000...0x80000 to 0x8ffff results for positions -32767...32767 or 0x8001..0x7fff (which is ~3200 grid units, used usual -100..100)

See Also:

Constant Field Values

same

public static final int same

This value applied at any coordinate parameter of any setPosition- method means, that the value is the same as the previous or given position.

See Also:

Constant Field Values

next

public static final int next

Use the next value for the coordinate in relation to the last one for the given direction but the same value for the other coordinate. It is the typical value for both coordinates if a quasi-float layout is desired. This value can be applied to x, xEnd, y, yEnd or to the float given arguments of any setPosition- method. It uses xEnd for x and yEnd for y with the adequate fractional parts. The new value for xEnd or yEnd is calculated using the size if this value is applied to them.

See Also:

Constant Field Values

nextBlock

public static final int nextBlock

Use the next value for the coordinate in relation to the last one. This value can be applied to x, xEnd, y, yEnd or to the float given arguments of any setPosition- method. It uses xEnd for x and yEnd for y with the adequate fractional parts. The new value for xEnd or yEnd is calculated using the size if this value is applied to them.

See Also:

Constant Field Values

invalidPos

public static final int invalidPos

0xdffff Marker for invalid, to check

See Also:

Constant Field Values

useNatSize

public static final int useNatSize

This value 0x0c000 at xEnd or yEnd means, that the native size of a widget should be used. It is especially to draw images with its native size. This is a bit mask. The nature size is stored in the bits 12..0, that is maximal 8191 pixel

See Also:

Constant Field Values

ratio

public static final int ratio

This mask 0xa... at all coordinates means, that the value is given as ratio from the size. The bit useNatSize have to be 0. The ratio is stored as a value from 0 to 999 in the bits 9..0. The other bits should be 0.

See Also:

Constant Field Values

size

public static final int size

This adding value at xEnd or yEnd or the float presentations of the calling argument of any setPosition- method means, that the value is the size, not the position. A size can be positive or negative.

See Also:

Constant Field Values

samesize

public static final int samesize

Use the same size.

See Also:

Constant Field Values

areaNr

public static final int areaNr

Values 0ex001..0xe003 as number of a GralArea9Panel A..C for columns, 1..3 for rows

See Also:

Constant Field Values

mValueRange_

private static final int mValueRange_

Bits in an integer position value for range and size. of relative position values for size, percent and refer. The mask for the value is 0x1fff. The range of any value is from 0x0 to 0x0fff for positive values and from 0x1fff downto 0x1000 for negative values. The value == 0 is designated with 0x0 after mask.

See Also:

Constant Field Values

mValueNegative

private static final int mValueNegative

Bits in an integer position value for range and size. of relative position values for size, percent and refer. The mask for the value is 0x1fff. The range of any value is from 0x0 to 0x0fff for positive values and from 0x1fff downto 0x1000 for negative values. The value == 0 is designated with 0x0 after mask.

See Also:

Constant Field Values

mType_

private static final int mType_

Bits in an integer position value for the type. If the type should be tested, the mTypwAdd_ should be added before masking. That is because the negative values for a specific type are disposed type - value

See Also:

Constant Field Values

kTypAdd_

private static final int kTypAdd_

Bits in an integer position value for the type. If the type should be tested, the mTypwAdd_ should be added before masking. That is because the negative values for a specific type are disposed type - value

See Also:

Constant Field Values

mSpecialType

private static final int mSpecialType

Bit masks for the special types next, nextBlock, useNatSize.

See Also:

Constant Field Values

kSpecialType

private static final int kSpecialType

Bit masks for the special types next, nextBlock, useNatSize.

See Also:

Constant Field Values

XXXmCheckRatio_

private static final int XXXmCheckRatio_

Mask to check ratio. This bits should be mask and the ratio value should compare with them.

See Also:

Constant Field Values

XXXmNatSize_

private static final int XXXmNatSize_

Mask for value of natural size. The maximum size is 16383 pixel.

See Also:

Constant Field Values

syntaxZbnf

public static final java.lang.String syntaxZbnf

Syntax of a position. It is

  position::= @ [<$?panel> ,]
       [ &+] [<#?yPos>[\\.<#?yPosFrac>]]
     [ [+] <#-?ySizeDown>[\\.<#?ySizeFrac>]| +*  |]
   [ , [ &+] [<#?xPos>[\\.<#?xPosFrac>]]
     [ [+] <#-?xWidth>[\\.<#?xSizeFrac>]| +*  |] [  ++]
   ].
 

The semantic identifier match to the elements in GralCfgPosition.

parent

public GralWidgetBase_ifc parent

Relation of x and y left and top to any separation line. 0 - relation to left and top border.

x

public final GralPos.Coordinate x

The values for x and y positions. Note: should be private! Don't use in application furthermore.

y

public final GralPos.Coordinate y

The values for x and y positions. Note: should be private! Don't use in application furthermore.

dbg

public boolean dbg

Constructor Detail

GralPos

public GralPos(GralMng gralMng)

Creates an position with all values 0 related to the whole screen. The position can be changed after them with setPosition(float, float) etc.

GralPos

public GralPos(GralWidgetBase_ifc parent)

Set a initial GralPos with the given widget as parent. The parent can be especially a GralPanelContent but also a GralWidgetBase - derived class which is a comprehensive widget (contains a few widgets). The initial position describes the whole area of the parent. This initial position can be used as reference position (refPos).
It is also possible recommended to mark the position with setAsFrame() for the child widgets.

Parameters:

panel - The given parent, a panel or comprehensive widget.

GralPos

public GralPos(GralPos src)

Creates a reference position from a given one.

Parameters:

src - the src position to copy all values.

GralPos

public GralPos(GralPos src,
               char direction)

Creates a reference position from a given one but modifies the next direction before applying a position string. Note: The next direction in the position string is always related to the next next position.

Parameters:

src - the src position to copy all values.

GralPos

public GralPos(GralMng mng,
               java.lang.String pos)
        throws java.text.ParseException

Throws:

java.text.ParseException

GralPos

public GralPos(GralWidget_ifc panel,
               java.lang.String pos)
        throws java.text.ParseException

Throws:

java.text.ParseException

Method Detail

set

public void set(GralPos pos)

Sets all values of this with the values of pos (copy values)

Parameters:

pos - The src pos

setParent

public GralPos setParent(GralWidgetBase_ifc parent)

Sets a panel, maybe the GralMng.screen as parent for the widget, where this GralPos is used. Note: If this is done after the position is determined by relative coordinates, the coordinates are already calculated using the parent before, if a refPos was not given.

Parameters:

parent - panel for the widget where the GralPos is used.

Returns:

setFullPanel

public void setFullPanel(GralPanelContent panel)

Sets the position to the given full panel.

Parameters:

panel -

setPosition

public void setPosition(float line,
                        float column)

setPositionSize

public void setPositionSize(int line,
                            int column,
                            int height,
                            int width,
                            char direction,
                            GralPos posFrame)

Sets a position in full grid coordinates and the size in full grid values.

Parameters:

line -

column -

height -

width -

direction -

posFrame -

setPosition

public GralPos setPosition(java.lang.CharSequence sPos)
                    throws java.text.ParseException

Set a new position in the same panel as given maybe relative to the own position.

Parameters:

sPos - See setPosition(CharSequence, GralPos)

Throws:

java.text.ParseException

setPosition

public void setPosition(java.lang.CharSequence sPos,
                        GralPos refPos)
                 throws java.text.ParseException

Sets the position with the given string representation.

 position::= [@] [<$?panel> ,]
                [ &+]
                [<#?yPos>[\.<#?yPosFrac>]]
                [ [+] <#-?ySizeDown>[\.<#?ySizeFrac>]| +*  |] ##| - <#?ySizeUp>|]
                [  ++]
                [ ,
                  [ &+]
                  [<#?xPos>[\.<#?xPosFrac>]]
                  [ [+] <#-?xWidth>[\.<#?xSizeFrac>]| +*  |]
                  [  ++]
                ] :
 ]

Parameters:

sPos - The syntax of the string see description of this class, starting with "@panel, ..." etc. for example "@windowA, 3..5, 16+20" for absolute line 3 and 4 (exclusive 5) and from absolute column 16, size-x=20. The position can be given without panel designation or relative, then the posParent argument is necessary.

refPos - necessary to build the absolute position from relative given sPos, maybe null then this is used itself as reference.

Throws:

java.text.ParseException - on errors of sPos or missing posParent if necessary.

scanPosition

private void scanPosition(StringPartScan spPos,
                          GralPos.Coordinate co)
                   throws java.text.ParseException

Scans one coordinate.

 [[+|%]<#?p1>[.<#p2Frac>] [..|]] <#?p2>[.<#p2Frac>]
 

If only the right number is given, p1 is refer

Parameters:

spPos -

co -

Throws:

java.text.ParseException

setPosition

public void setPosition(GralPos refPos,
                        float line,
                        float lineEndOrSize,
                        float column,
                        float columnEndOrSize,
                        char direction,
                        float border)

Sets the position with given grid coordinates in float. The first

Parameters:

refPos - The frame or last pos for relative positions.

line - The line. If the parameter lineEndOrSize is designated with size with a negative value, it is the bottom line for the position. If it is designated with same without offset and the lineEndOrSize is designated with size with a negative value, the framePos GralPos#y.p2 is used. If it is designated with same but with any offset, the y is used as refer position, it is the top line position. Elsewhere it is the top position.

lineEndOrSize - Maybe designated with size or samesize

column -

columnEndOrSize -

direction -

setPosition

public void setPosition(GralPos framePos,
                        float line,
                        float lineEndOrSize,
                        float column,
                        float columnEndOrSize)

Sets the position

Parameters:

framePos - The frame or last pos for relative positions.

line - The line. If the parameter lineEndOrSize is designated with size with a negative value, it is the bottom line for the position. If it is designated with same without offset and the lineEndOrSize is designated with size with a negative value, the framePos GralPos#y.p2 is used. If it is designated with same but with any offset, the y is used as refer position, it is the top line position. Elsewhere it is the top position.

lineEndOrSize - Maybe designated with size or samesize

column -

columnEndOrSize -

direction -

toResize

public boolean toResize()

Returns true if this position is from right or bottom, so that a resize of the parent needs new positions for this widget.

setFinePosition

@Deprecated
public void setFinePosition(int line,
                                         int yPosf,
                                         int lineEndOrSize,
                                         int yef,
                                         int column,
                                         int xPosf,
                                         int columnEndOrSize,
                                         int xef,
                                         char direction,
                                         int border,
                                         int borderFrac,
                                         GralPos refPos)

Deprecated. use set10Position(int, int, int, int, char, int, GralPos) for immediately replacement with 10*line + yPosf etc. or use setPosition(GralPos, float, float, float, float, char, float)

Sets a fine position only with integer values, instead float as in #setPosition(GralPos, float, float, float, float, int, char, float) This operation is not recommended, should use the float version. It is the old form till 2022, where the grid positions and fine positions were stored in two different variables. The nwer variant set10Position(int, int, int, int, char, int, GralPos) use only one value for grid and fine position but with factor 10.

set10Position

public void set10Position(int yPos,
                          int ye,
                          int xPos,
                          int xe,
                          char direction,
                          int border,
                          GralPos refPos)

Sets the position for the next widget to add in the container. This is the core function to calculate positions. It is called from all other ones. It calls Coordinate#set(int, int, String, Coordinate) for both coordinates.

• All positions are grid fine units. It means 10* grid unit + fine unit. The fine unit is 0..9.
• The position counts from 0 ... from top or left in the spread of the given parent widget or it counts from negative till ... 0 from bottom or right. For the end positions: 0 is bottom or right.
• The positions yPos, xPos can be given with same, next. It is related to the refPos or this.
• The positions ye, xe can be given with samesize, then the end position is calculated from the start position and the size of the parent (or the given size)
• The values of all positions can be completed (| or +) with refer, ratio, useNatSize,
• The values of the end positons ye, xe can be completed (| or +) with size
• The end positions can be completed (or or +) with size,

Note: The fine unit continues the position in the same direction as the grid unit. This is since 2022-12, in the past (2009..2022) the fine position counts always from top and left, also on negative grid positions. That is a detail, the now found solution is more understandable. Also changed in 2022-12: before, there were two integer numbers for grid and fine potition. Now as described, the integer position is 10 * the grid position + fine positon from 0..9

Parameters:

yPos - start position of the spread (top)

xPos - start position of the spread (left)

ye: - end position of the spread (bottom) or the size with + size

xe - end position of the spread (right) or the size with + size

direction: - direction for a next widget, use 'r', 'l', 'u', 'd' for right, left, up, down

border - border for a next position calculation.

refPos - If given, it is the base for calculation. If null, this itself is the base.

setSize

public void setSize(float height,
                    float width,
                    GralPos frame)

Sets the position, direction as frame, but the size as given.

Parameters:

height - grid units + .fine units

width -

frame - if null, it does not change the own values.

setAsFrame

public GralPos setAsFrame()

Mark the position as frame position for some other derived positions. If this is done, the position itself won't be changed as reference by positioning in the GralWidget posName string. Instead firstly a clone is done and the clone is changed for only the widget. This position remain unchanged. Hint: To refer to the last widget's position you can also use the GralWidgetBase.pos() value.
From this position next cannot be used.
Example for usage:

 GralPos framePos = super.pos().setAsFrame();                   // from a comprehensive widget.
 this.mySubWdg1 = new TextField(framePos, "@2+2, 10..-10=text"); //position is related to framePos
 

 If for that example the framePos contains "@10..20, 6..-20" inside a panel,
 the resulting position for the text widget is "@12+2, 16..-30" related to the panel.
 

 This property is regarded especially in #setFinePosition(int, int, int, int, int, int, int, int, int, char, int, int, GralPos)
 and also in all positioning operations.

Returns:

this

screenPos

public GralPos screenPos(int line,
                         int col,
                         int dy,
                         int dx)

Returns the position on the screen relative to the given pos Note: the from positions should be only >0 TODO

Parameters:

line -

col -

dy -

dx -

Returns:

checkSetNext

public void checkSetNext()

This operation should be called before usage the position. If the dirNext is in upper case, #setNextPosition() is called. This is the state where no setPosition was called after last usage. The Position#dirNext of the x coord is set to upper case after them to mark it for the next call of checkSetNext().

setUsed

public void setUsed()

Marks the position as used. The GralPos.Coordinate.dirNext is set to upper case. This operation should be called (is called in GralWidgetBase.GralWidgetBase(GralPos, String, GralMng)) if the position is used as reference by any widget. If it is used for a next widget without given position string, then the called checkSetNext() calculates the next position in the given direction.

assertCorrectness

public void assertCorrectness()

xGrid

public float xGrid()

height

public float height()

Returns the height in grid position + fine position as one digit after dot.

Returns:

for example 5.3 5 grid units + 3 fine units.

width

public float width()

Returns the width in grid position + fine position as one digit after dot.

Returns:

for example 5.3 5 grid units + 3 fine units.

clone

public GralPos clone()

Creates a new position instance with the same values.

Overrides:

clone in class java.lang.Object

calcNextPos

@Deprecated
public GralPos calcNextPos(java.lang.String posString)
                                 throws java.text.ParseException

Deprecated. use setPosition(CharSequence)

Sets the given position with the given posString.

Parameters:

posString - "@parent,line, col:" syntax see description on class level.

Returns:

new calculated position equal to this. The clone is done because the result is intend to use as position for the current Gral Widget during building the Gui. This instance is furthermore used as currently calculated, the widget aggregates a

Throws:

java.text.ParseException

calcWidgetPosAndSize

public GralRectangle calcWidgetPosAndSize(GralGridProperties propertiesGui,
                                          GralRectangle parentPix,
                                          int widthWidgetNat,
                                          int heightWidgetNat)

Calculates the position and size of a widget from this given Pos. This operation is only intend to use internally. Call GralMng#calcWidgetPosAndSize(GralPos, int, int, int, int), The GralMng instance knows the propertiesGui

Parameters:

propertiesGui - The properties for presentation.

widthParentPixel - width of the container. This value will be used if the position is given from right with negative numbers.

heightParentPixel - height of the container. This value will be used if the position is given from bottom with negative numbers.

widthWidgetNat - natural width of the component which will be positioning. This value is used only if the pos parameter contains useNatSize for the xe-value

heightWidgetNat - natural height of the component which will be positioning. This value is used only if the pos parameter contains useNatSize for the ye-value

Returns:

A rectangle for setBounds. It is exclusively the right and bottom pixel. dx and dy are calc -1

appendPos

public static void appendPos(java.lang.Appendable b,
                             int p)
                      throws java.io.IOException

Throws:

java.io.IOException

posString

public java.lang.String posString()

Returns the position in a syntax which is able to parse Useful to write back to a configuration file.

toString

public java.lang.StringBuilder toString(java.lang.StringBuilder b,
                                        java.lang.String... appendPanel)

Append position to given Appendable, for toString of using widgets.

Parameters:

b - append here

Returns:

b for concatenate.

Throws:

java.io.IOException - can be force RuntimeException if a StringBuilder is given as Appendable

toString

public java.lang.String toString()

Use especially for debug.

Overrides:

toString in class java.lang.Object

See Also:

Object.toString()

stop

void stop()