Maven module :un.api : api-display :
Class : un.api.layout.Positionable
Extends/Implements : un.api.event.EventSource
Subclasses : -

A positionable is similar to a scene node but holds descriptive informations
author Johann Sorel

Variables : PROPERTY_OVERRIDE_EXTENTS, PROPERTY_EXTENTS, PROPERTY_EFFECTIVE_EXTENT, PROPERTY_LAYOUT_CONSTRAINT, PROPERTY_VISIBLE, PROPERTY_RESERVE_SPACE
Functions : getOverrideExtents, setOverrideExtents, getEffectiveExtent, setEffectiveExtent, getExtents, getExtents, getExtents, getBoundingBox, getNodeTransform, isReserveSpace, setReserveSpace, setLayoutConstraint, getLayoutConstraint, setVisible, isVisible

Property storing override positionable extents.

public Chars PROPERTY_OVERRIDE_EXTENTS

Property storing current extents.
This extents is derived from effective extent and override extents.

public Chars PROPERTY_EXTENTS

Property indicating when the effective size change.
The extent may be set to zero if the positionable is not in the visible
area of the layout.

public Chars PROPERTY_EFFECTIVE_EXTENT

Property indicating when the layout constraint changed.

public Chars PROPERTY_LAYOUT_CONSTRAINT

Property indicating if the positionable is visible.

public Chars PROPERTY_VISIBLE

Property indicating when the reserve space change.

public Chars PROPERTY_RESERVE_SPACE

Get override extents.
Values which are not NaN are consider override.
return copy of the override extents, nerver null

Extents getOverrideExtents ()

Set override extents including min, best and max extents.
param ext, values will be copied

void setOverrideExtents (Extents ext)

Get the current positionable size.
return size of the positionable

Extent getEffectiveExtent ()

Set current positionable size.
param extent effective size of the positionable

void setEffectiveExtent (Extent extent)

Minimum,best and maximum extent the layout needs for the current view.
Under minimum size or over maximum the layout won't have a proper rendering.
return Extent, never null

Extents getExtents ()

Get Extents.
param buffer can be null
return Extent, never null

Extents getExtents (Extents buffer)

Calculate min, best and max extents based on given constraint.

Under minimum size the positionable won't have enough space
Best extent provide the most appropriate spacing.
Over maximum size the positionable will be over-stretched or have wasted space.

param buffer can be null
param constraint can be null
return

Extents getExtents (Extents buffer, Extent constraint)

Get the current positionable bbox.
This bbox is centered version of the effective extent.
return bbox of the positionable

BBox getBoundingBox ()

return this positionable transform

NodeTransform getNodeTransform ()

Indicate if the widget space in the layout should be reserved when the
widget is not visible.
Default value is TRUE.
return true if widget space should be reserved

boolean isReserveSpace ()

param reserve true to reserve space when widget is not visible

void setReserveSpace (boolean reserve)

Set widget layout constraint.
param layoutConstraint may be null

void setLayoutConstraint (LayoutConstraint layoutConstraint)

Get wished layout constraint.
return LayoutConstraint, may be null

LayoutConstraint getLayoutConstraint ()

Set element visibility, visible or unvisible.
param visible

void setVisible (boolean visible)

return true if element is visible

boolean isVisible ()