jfxtras.labs.scene.layout

Class DefaultOptimizationRule

java.lang.Object

jfxtras.labs.scene.layout.DefaultOptimizationRule

All Implemented Interfaces:

OptimizationRule

public class DefaultOptimizationRule
extends java.lang.Object
implements OptimizationRule

Default optimization rule. It uses the scene area occupied by the pane and min(width,height) to optimize,e.g., to decide whether to visualize the children of the pane (see OptimizableContentPane).

Property Summary

Properties

Type	Property and Description
javafx.beans.property.BooleanProperty	attachNodes
javafx.beans.property.DoubleProperty	minSceneArea
javafx.beans.property.DoubleProperty	minSceneDimension

Constructor Summary

Constructors

Constructor and Description
DefaultOptimizationRule()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	attached(OptimizableContentPane p, javafx.scene.transform.Transform t) Indicates whether the children of the pane shall be attached to the scene graph.
javafx.beans.property.BooleanProperty	attachNodesProperty()
double	getMinSceneArea() Returns the minimum scene area.
double	getMinSceneDimension() Returns the minimum scene dimension.
boolean	isAttachNodes() Indicates whether this optimization shall attach/detach nodes from the scene graph.
javafx.beans.property.DoubleProperty	minSceneAreaProperty()
javafx.beans.property.DoubleProperty	minSceneDimensionProperty()
void	setAttachNodes(boolean attach) Defines whether this optimization shall attach/detach nodes from the scene graph.
void	setMinSceneArea(double s) Defines the minimum scene area.
void	setMinSceneDimension(double d) Defines the minimum scene dimension.
boolean	visible(OptimizableContentPane p, javafx.scene.transform.Transform t) Indicates whether the children of the pane shall be visualized.

Methods inherited from class java.lang.Object

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

Property Detail

minSceneArea

Returns:

minimum scene area property

minSceneDimension

Returns:

minimum scene dimension property

attachNodes

Returns:

the attach property

Constructor Detail

DefaultOptimizationRule

public DefaultOptimizationRule()

Method Detail

visible

public boolean visible(OptimizableContentPane p,
              javafx.scene.transform.Transform t)

Description copied from interface: OptimizationRule

Indicates whether the children of the pane shall be visualized.

Specified by:

visible in interface OptimizationRule

Parameters:

p - pane

t - current transformation

Returns:

true if the children shall be visible; false otherwise

attached

public boolean attached(OptimizableContentPane p,
               javafx.scene.transform.Transform t)

Description copied from interface: OptimizationRule

Indicates whether the children of the pane shall be attached to the scene graph.

Specified by:

attached in interface OptimizationRule

Parameters:

p - pane

t - current transformation

Returns:

true if the children shall be attached to the scene graph; false otherwise

minSceneAreaProperty

public javafx.beans.property.DoubleProperty minSceneAreaProperty()

Returns:

minimum scene area property

setMinSceneArea

public void setMinSceneArea(double s)

Defines the minimum scene area. If the area occupied by the pane is less than the specified value the children of the pane will be invisible.

Parameters:

s -

getMinSceneArea

public double getMinSceneArea()

Returns the minimum scene area.

Returns:

the minimum scene area

minSceneDimensionProperty

public javafx.beans.property.DoubleProperty minSceneDimensionProperty()

Returns:

minimum scene dimension property

setMinSceneDimension

public void setMinSceneDimension(double d)

Defines the minimum scene dimension. If min(width,height) is less than the specified vaule the children of the pane will be invisible.

Parameters:

d - minimum scene dimension

getMinSceneDimension

public double getMinSceneDimension()

Returns the minimum scene dimension.

Returns:

the minimum scene dimension

attachNodesProperty

public javafx.beans.property.BooleanProperty attachNodesProperty()

Returns:

the attach property

setAttachNodes

public void setAttachNodes(boolean attach)

Defines whether this optimization shall attach/detach nodes from the scene graph.

Parameters:

attach - the state to set

isAttachNodes

public boolean isAttachNodes()

Indicates whether this optimization shall attach/detach nodes from the scene graph.

Returns:

true if nodes shall be attached/detached; false otherwise