Module io.github.mmm.ui.api.window

Package io.github.mmm.ui.spi.window

Class UiWindowPositionAndSize

java.lang.Object

io.github.mmm.ui.spi.window.UiWindowPositionAndSize

All Implemented Interfaces:

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

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

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)
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

setWidthInPixel

public void setWidthInPixel(double width)

Specified by:

setWidthInPixel in interface AttributeWriteSize

Specified by:

setWidthInPixel in interface AttributeWriteSizeInPixel

setWidth

public void setWidth(UiSize width)

Specified by:

setWidth in interface AttributeWriteSize

getHeightInPixel

public double getHeightInPixel()

Specified by:

getHeightInPixel in interface AttributeReadSize

setHeightInPixel

public void setHeightInPixel(double height)

Specified by:

setHeightInPixel in interface AttributeWriteSize

Specified by:

setHeightInPixel in interface AttributeWriteSizeInPixel

setHeight

public void setHeight(UiSize height)

Specified by:

setHeight in interface AttributeWriteSize

setSizeInPixel

public void setSizeInPixel(double width,
                           double height)

Specified by:

setSizeInPixel in interface AttributeWriteSize

Specified by:

setSizeInPixel in interface AttributeWriteSizeInPixel

setSize

public void setSize(UiSize width,
                    UiSize height)

Specified by:

setSize in interface AttributeWriteSize

getMinWidth

public double getMinWidth()

Specified by:

getMinWidth in interface AttributeWriteSizeRange

setMinWidth

public void setMinWidth(double minWidth)

Specified by:

setMinWidth in interface AttributeWriteSizeRange

getMaxWidth

public double getMaxWidth()

Specified by:

getMaxWidth in interface AttributeWriteSizeRange

setMaxWidth

public void setMaxWidth(double maxWidth)

Specified by:

setMaxWidth in interface AttributeWriteSizeRange

getMinHeight

public double getMinHeight()

Specified by:

getMinHeight in interface AttributeWriteSizeRange

setMinHeight

public void setMinHeight(double minHeight)

Specified by:

setMinHeight in interface AttributeWriteSizeRange

getMaxHeight

public double getMaxHeight()

Specified by:

getMaxHeight in interface AttributeWriteSizeRange

setMaxHeight

public void setMaxHeight(double maxHeight)

Specified by:

setMaxHeight in interface AttributeWriteSizeRange

getX

public double getX()

Specified by:

getX in interface AttributeReadPosition

setX

public void setX(double x)

Specified by:

setX in interface AttributeWritePosition

getY

public double getY()

Specified by:

getY in interface AttributeReadPosition

setY

public void setY(double y)

Specified by:

setY in interface AttributeWritePosition

setPosition

public void setPosition(double x,
                        double y)

Specified by:

setPosition in interface AttributeWritePosition

getMinX

public double getMinX()

Specified by:

getMinX in interface AttributeWritePositionRange

setMinX

public void setMinX(double minX)

Specified by:

setMinX in interface AttributeWritePositionRange

getMaxX

public double getMaxX()

Specified by:

getMaxX in interface AttributeWritePositionRange

setMaxX

public void setMaxX(double maxX)

Specified by:

setMaxX in interface AttributeWritePositionRange

getMinY

public double getMinY()

Specified by:

getMinY in interface AttributeWritePositionRange

setMinY

public void setMinY(double minY)

Specified by:

setMinY in interface AttributeWritePositionRange

getMaxY

public double getMaxY()

Specified by:

getMaxY in interface AttributeWritePositionRange

setMaxY

public void setMaxY(double maxY)

Specified by:

setMaxY in interface AttributeWritePositionRange

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.