java.lang.Object
- io.github.mmm.ui.spi.window.UiWindowPositionAndSize

All Implemented Interfaces:

AttributeReadPosition, AttributeReadSize, AttributeWritePosition, AttributeWritePositionRange, AttributeWriteSize, AttributeWriteSizeInPixel, AttributeWriteSizeRange

Direct Known Subclasses:

FxAbstractWindowPositionAndSize, TestAbstractWindowPositionAndSize
```
public abstract class UiWindowPositionAndSize
extends Object
implements AttributeWritePositionRange, AttributeWriteSizeRange
```
Abstract base implementation for position, size and controls related attributes of UiAbstractWindow or UiChildWindow.

Since:

1.0.0

Field Summary

Fields
Modifier and Type	Field	Description
`protected double`	`height`
`protected double`	`maxHeight`
`protected double`	`maxWidth`
`protected double`	`maxX`
`protected double`	`maxY`
`protected double`	`minHeight`
`protected double`	`minWidth`
`protected double`	`minX`
`protected double`	`minY`
`protected double`	`width`
`protected double`	`x`
`protected double`	`y`

Constructor Summary

Constructors
Constructor Description

UiWindowPositionAndSize()
The constructor.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`centerOnScreen(boolean force)`	Initializes the position and size.
`protected static double`	`clipMax(double max)`
`protected static double`	`clipSize(double size)`
`protected static double`	`clipZero(double pos)`
`double`	`getHeightInPixel()`
`double`	`getMaxHeight()`
`double`	`getMaxWidth()`
`double`	`getMaxX()`
`double`	`getMaxY()`
`double`	`getMinHeight()`
`double`	`getMinWidth()`
`double`	`getMinX()`
`double`	`getMinY()`
`protected abstract double`	`getScreenHeight()`
`protected abstract double`	`getScreenWidth()`
`double`	`getWidthInPixel()`
`double`	`getX()`
`double`	`getY()`
`void`	`setHeight(UiSize height)`
`void`	`setHeightInPixel(double height)`
`void`	`setMaxHeight(double maxHeight)`
`void`	`setMaxWidth(double maxWidth)`
`void`	`setMaxX(double maxX)`
`void`	`setMaxY(double maxY)`
`void`	`setMinHeight(double minHeight)`
`void`	`setMinWidth(double minWidth)`
`void`	`setMinX(double minX)`
`void`	`setMinY(double minY)`
`void`	`setPosition(double x, double y)`	This method sets the position of the widget.
`void`	`setSize(UiSize width, UiSize height)`
`void`	`setSizeInPixel(double width, double height)`
`void`	`setWidth(UiSize width)`
`void`	`setWidthInPixel(double width)`
`void`	`setX(double x)`
`void`	`setY(double y)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.github.mmm.ui.api.attribute.AttributeReadSize
getHeight, getWidth

Methods inherited from interface io.github.mmm.ui.api.attribute.AttributeWritePositionRange
setXRange, setYRange

Methods inherited from interface io.github.mmm.ui.api.attribute.AttributeWriteSize
setSize

Methods inherited from interface io.github.mmm.ui.api.attribute.AttributeWriteSizeRange
setHeightRange, setWidthRange

- Field Detail
  - x
```
protected double x
```
    See Also:
    
    getX()
  - y
```
protected double y
```
    See Also:
    
    getY()
  - minX
```
protected double minX
```
    See Also:
    
    getMinX()
  - minY
```
protected double minY
```
    See Also:
    
    getMinY()
  - maxX
```
protected double maxX
```
    See Also:
    
    getMaxX()
  - maxY
```
protected double maxY
```
    See Also:
    
    getMaxY()
  - width
```
protected double width
```
    See Also:
    
    AttributeReadSize.getWidth()
  - height
```
protected double height
```
    See Also:
    
    AttributeReadSize.getHeight()
  - minWidth
```
protected double minWidth
```
    See Also:
    
    getMinWidth()
  - minHeight
```
protected double minHeight
```
    See Also:
    
    getMinHeight()
  - maxWidth
```
protected double maxWidth
```
    See Also:
    
    getMaxWidth()
  - maxHeight
```
protected double maxHeight
```
    See Also:
    
    getMaxHeight()
- Constructor Detail
  - UiWindowPositionAndSize
```
public UiWindowPositionAndSize()
```
    The constructor.
- Method Detail
  - getWidthInPixel
```
public double getWidthInPixel()
```
    Specified by:
    
    getWidthInPixel in interface AttributeReadSize
    
    Returns:
    
    the width of this object in pixels.
    NOTE: The result will typically be an int value. However, to be compatible with UiSize.getAmount() and with some underlying native toolkits we use double. You may cast the result to int.
  - setWidthInPixel
```
public void setWidthInPixel(double width)
```
    Specified by:
    
    setWidthInPixel in interface AttributeWriteSize
    
    Specified by:
    
    setWidthInPixel in interface AttributeWriteSizeInPixel
    
    Parameters:
    
    width - the new width in pixel.
  - setWidth
```
public void setWidth(UiSize width)
```
    Specified by:
    
    setWidth in interface AttributeWriteSize
    
    Parameters:
    
    width - the new width.
  - getHeightInPixel
```
public double getHeightInPixel()
```
    Specified by:
    
    getHeightInPixel in interface AttributeReadSize
    
    Returns:
    
    the height of this object in pixels.
    NOTE: The result will typically be an int value. However, to be compatible with UiSize.getAmount() and with some underlying native toolkits we use double. You may cast the result to int.
  - setHeightInPixel
```
public void setHeightInPixel(double height)
```
    Specified by:
    
    setHeightInPixel in interface AttributeWriteSize
    
    Specified by:
    
    setHeightInPixel in interface AttributeWriteSizeInPixel
    
    Parameters:
    
    height - the new height in pixel.
  - setHeight
```
public void setHeight(UiSize height)
```
    Specified by:
    
    setHeight in interface AttributeWriteSize
    
    Parameters:
    
    height - the new height.
  - setSizeInPixel
```
public void setSizeInPixel(double width,
                           double height)
```
    Specified by:
    
    setSizeInPixel in interface AttributeWriteSize
    
    Specified by:
    
    setSizeInPixel in interface AttributeWriteSizeInPixel
    
    Parameters:
    
    width - the new width in pixel.
    
    height - the new height in pixel.
  - setSize
```
public void setSize(UiSize width,
                    UiSize height)
```
    Specified by:
    
    setSize in interface AttributeWriteSize
    
    Parameters:
    
    width - the new width.
    
    height - the new height.
  - getMinWidth
```
public double getMinWidth()
```
    Specified by:
    
    getMinWidth in interface AttributeWriteSizeRange
    
    Returns:
    
    the minimum allowed value of width in pixel. Will be 200 by default. Should be less or equal to maxWidth.
  - setMinWidth
```
public void setMinWidth(double minWidth)
```
    Specified by:
    
    setMinWidth in interface AttributeWriteSizeRange
    
    Parameters:
    
    minWidth - the new value of minWidth. Will not affect current width but only apply to resizing by the end-user.
  - getMaxWidth
```
public double getMaxWidth()
```
    Specified by:
    
    getMaxWidth in interface AttributeWriteSizeRange
    
    Returns:
    
    the maximum allowed value of width in pixel. Will be Integer.MAX_VALUE by default (unbounded) and is automatically clipped to the available width (of the UiScreen or main window). Should be greater or equal to minWidth.
  - setMaxWidth
```
public void setMaxWidth(double maxWidth)
```
    Specified by:
    
    setMaxWidth in interface AttributeWriteSizeRange
    
    Parameters:
    
    maxWidth - the new value of maxWidth. Will not affect current width but only apply to resizing by the end-user.
  - getMinHeight
```
public double getMinHeight()
```
    Specified by:
    
    getMinHeight in interface AttributeWriteSizeRange
    
    Returns:
    
    the minimum allowed value of height in pixel. Will be 200 by default. Should be less or equal to maxHeight.
  - setMinHeight
```
public void setMinHeight(double minHeight)
```
    Specified by:
    
    setMinHeight in interface AttributeWriteSizeRange
    
    Parameters:
    
    minHeight - the new value of minHeight. Will not affect current height but only apply to resizing by the end-user.
  - getMaxHeight
```
public double getMaxHeight()
```
    Specified by:
    
    getMaxHeight in interface AttributeWriteSizeRange
    
    Returns:
    
    the maximum allowed value of height in pixel. Will be Integer.MAX_VALUE by default (unbounded) and is automatically clipped to the available height (of the UiScreen or main window). Should be greater or equal to minHeight.
  - setMaxHeight
```
public void setMaxHeight(double maxHeight)
```
    Specified by:
    
    setMaxHeight in interface AttributeWriteSizeRange
    
    Parameters:
    
    maxHeight - the new value of maxHeight. Will not affect current height but only apply to resizing by the end-user.
  - getX
```
public double getX()
```
    Specified by:
    
    getX in interface AttributeReadPosition
    
    Returns:
    
    the x position of this object as the number of pixels from the left on the x-axis (horizontally).
  - setX
```
public void setX(double x)
```
    Specified by:
    
    setX in interface AttributeWritePosition
    
    Parameters:
    
    x - the new position on the x-axis.
  - getY
```
public double getY()
```
    Specified by:
    
    getY in interface AttributeReadPosition
    
    Returns:
    
    the y position of this object as the number of pixels from the top on the y-axis (vertically).
  - setY
```
public void setY(double y)
```
    Specified by:
    
    setY in interface AttributeWritePosition
    
    Parameters:
    
    y - the new position on the y-axis.
  - setPosition
```
public void setPosition(double x,
                        double y)
```
    Description copied from interface: AttributeWritePosition
    
    This method sets the position of the widget.
    
    Specified by:
    
    setPosition in interface AttributeWritePosition
    
    Parameters:
    
    x - the new position on the x-axis.
    
    y - the new position on the y-axis.
  - getMinX
```
public double getMinX()
```
    Specified by:
    
    getMinX in interface AttributeWritePositionRange
    
    Returns:
    
    the minimum allowed value of X. Will be 0 by default (unbounded). Should be less or equal to maxX.
  - setMinX
```
public void setMinX(double minX)
```
    Specified by:
    
    setMinX in interface AttributeWritePositionRange
    
    Parameters:
    
    minX - the new value of minX. Will not affect current X coordinate but only apply to moving and resizing by the end-user.
  - getMaxX
```
public double getMaxX()
```
    Specified by:
    
    getMaxX in interface AttributeWritePositionRange
    
    Returns:
    
    the maximum allowed value of X. Will be Integer.MAX_VALUE by default (unbounded) and is automatically clipped to the available width (of the UiScreen or main window). Should be greater or equal to minX.
  - setMaxX
```
public void setMaxX(double maxX)
```
    Specified by:
    
    setMaxX in interface AttributeWritePositionRange
    
    Parameters:
    
    maxX - the new value of maxX. Will not affect current X coordinate but only apply to moving and resizing by the end-user.
  - getMinY
```
public double getMinY()
```
    Specified by:
    
    getMinY in interface AttributeWritePositionRange
    
    Returns:
    
    the minimum allowed value of Y. Will be 0 by default (unbounded). Should be less or equal to maxY.
  - setMinY
```
public void setMinY(double minY)
```
    Specified by:
    
    setMinY in interface AttributeWritePositionRange
    
    Parameters:
    
    minY - the new value of minY. Will not affect current Y coordinate but only apply to moving and resizing by the end-user.
  - getMaxY
```
public double getMaxY()
```
    Specified by:
    
    getMaxY in interface AttributeWritePositionRange
    
    Returns:
    
    the maximum allowed value of Y. Will be Integer.MAX_VALUE by default (unbounded) and is automatically clipped to the available width (of the UiScreen or main window). Should be greater or equal to minY.
  - setMaxY
```
public void setMaxY(double maxY)
```
    Specified by:
    
    setMaxY in interface AttributeWritePositionRange
    
    Parameters:
    
    maxY - the new value of maxY. Will not affect current Y coordinate but only apply to moving and resizing by the end-user.
  - getScreenWidth
```
protected abstract double getScreenWidth()
```
    Returns:
    
    the current width of the screen available for child windows.
  - getScreenHeight
```
protected abstract double getScreenHeight()
```
    Returns:
    
    the current height of the screen available for child windows.
  - centerOnScreen
```
public void centerOnScreen(boolean force)
```
    Initializes the position and size. If neither of those is set, size will be set to a quarter of the screen (half of screen width and height) and window is centered on the screen.
    
    Parameters:
    
    force - true to always update X and Y to center the window on the screen, false to only update X and Y in case they are uninitialized (-1).
  - clipSize
```
protected static double clipSize(double size)
```
    Parameters:
    
    size - the width or height to clip.
    
    Returns:
    
    the maximum of the given size and 100.
  - clipZero
```
protected static double clipZero(double pos)
```
    Parameters:
    
    pos - the position value.
    
    Returns:
    
    the maximum of the given pos and 0.
  - clipMax
```
protected static double clipMax(double max)
```
    Parameters:
    
    max - the maximum value.
    
    Returns:
    
    the given max clipped to the range from 0 to Integer.MAX_VALUE.

Class UiWindowPositionAndSize

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface io.github.mmm.ui.api.attribute.AttributeReadSize

Methods inherited from interface io.github.mmm.ui.api.attribute.AttributeWritePositionRange

Methods inherited from interface io.github.mmm.ui.api.attribute.AttributeWriteSize

Methods inherited from interface io.github.mmm.ui.api.attribute.AttributeWriteSizeRange

Field Detail

x

y

minX

minY

maxX

maxY

width

height

minWidth

minHeight

maxWidth

maxHeight

Constructor Detail

UiWindowPositionAndSize

Method Detail

getWidthInPixel

setWidthInPixel

setWidth

getHeightInPixel

setHeightInPixel

setHeight

setSizeInPixel

setSize

getMinWidth

setMinWidth

getMaxWidth

setMaxWidth

getMinHeight

setMinHeight

getMaxHeight

setMaxHeight

getX

setX

getY

setY

setPosition

getMinX

setMinX

getMaxX

setMaxX

getMinY

setMinY

getMaxY

setMaxY

getScreenWidth

getScreenHeight

centerOnScreen

clipSize

clipZero

clipMax