Modifier and Type	Class and Description
private abstract class	TraversalEngine.BaseEngineContext The base class for all engine contexts
private class	TraversalEngine.EngineContext
private class	TraversalEngine.TempEngineContext

Modifier and Type	Field and Description
protected final Algorithm	algorithm
private final TraversalContext	context
pack-priv static final Algorithm	DEFAULT_ALGORITHM This is the default algorithm for the running platform.
private final Bounds	initialBounds
private final ArrayList<TraverseListener>	listeners
private final TraversalEngine.TempEngineContext	tempEngineContext

Access	Constructor and Description
protected	TraversalEngine(Algorithm algorithm) Creates engine with the specified algorithm
protected	TraversalEngine() Creates engine with no algorithm.

Method Summary

Modifier and Type	Method and Description
public final void	addTraverseListener(TraverseListener listener) Add a listener to traversal engine.
public final boolean	canTraverse() Returns true only if there's specified algorithm for this engine.
private Bounds	Returns: bounds of node in `forParent` coordinates or scene coordinates if `forParent` is null getLayoutBounds(Node n, Parent forParent) Gets the appropriate bounds for the given node, transformed into the scene's or the specified node's coordinates.
protected abstract Parent	Returns: This engine's root getRoot() The root of this engine's context.
pack-priv final void	notifyTraversedTo(Node the node which has been focused newNode) Fire notifications for listeners.
public final Node	Returns: the subsequent node in the specified direction or null if none select(Node the node to start traversal from from, Direction the direction of traversal dir) Returns the node that is in the direction `dir` starting from the Node `from` using the engine's algorithm.
public final Node	Returns: The first node or null if none exists selectFirst() Returns the first node in this engine's context (scene/parent) using the engine's algorithm.
public final Node	Returns: The last node or null if none exists selectLast() Returns the last node in this engine's context (scene/parent) using the engine's algorithm.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

algorithm	back to summary
protected final Algorithm algorithm

context	back to summary
private final TraversalContext context

DEFAULT_ALGORITHM	back to summary
pack-priv static final Algorithm DEFAULT_ALGORITHM This is the default algorithm for the running platform. It's the algorithm that's used in TopMostTraversalEngine

initialBounds	back to summary
private final Bounds initialBounds

listeners	back to summary
private final ArrayList<TraverseListener> listeners

tempEngineContext	back to summary
private final TraversalEngine.TempEngineContext tempEngineContext

TraversalEngine	back to summary
protected TraversalEngine(Algorithm algorithm) Creates engine with the specified algorithm

TraversalEngine	back to summary
protected TraversalEngine() Creates engine with no algorithm. This makes all the select* calls invalid. See Also `canTraverse()`

Method Detail

addTraverseListener	back to summary
public final void addTraverseListener(TraverseListener listener) Add a listener to traversal engine. The listener is notified whenever focus is changed by traversal inside the associated scene or parent. This can be used with ParentTraversalEngine that has no algorithm to observe changes to the focus inside the parent.

canTraverse	back to summary
public final boolean canTraverse() Returns true only if there's specified algorithm for this engine. Otherwise, this engine cannot be used for traversal. The engine might be still useful however, e.g. for listening on traversal changes.

getLayoutBounds back to summary

getLayoutBounds	back to summary
private Bounds getLayoutBounds(Node n, Parent forParent) Gets the appropriate bounds for the given node, transformed into the scene's or the specified node's coordinates. Returns:Bounds bounds of node in `forParent` coordinates or scene coordinates if `forParent` is null

private Bounds getLayoutBounds(Node n, Parent forParent)

Gets the appropriate bounds for the given node, transformed into the scene's or the specified node's coordinates.

Returns:Bounds: bounds of node in forParent coordinates or scene coordinates if forParent is null

getRoot	back to summary
protected abstract Parent getRoot() The root of this engine's context. This is the node that is the root of the tree that is traversed by this engine. Returns:Parent This engine's root

getRoot

back to summary

protected abstract Parent getRoot()

The root of this engine's context. This is the node that is the root of the tree that is traversed by this engine.

Returns:Parent: This engine's root

notifyTraversedTo	back to summary
pack-priv final void notifyTraversedTo(Node newNode) Fire notifications for listeners. This is called from the TopMostTraversalEngine Parameters newNode:Node the node which has been focused

notifyTraversedTo

back to summary

pack-priv final void notifyTraversedTo(Node newNode)

Fire notifications for listeners. This is called from the TopMostTraversalEngine

Parameters

newNode:Node: the node which has been focused

select back to summary

select	back to summary
public final Node select(Node from, Direction dir) Returns the node that is in the direction `dir` starting from the Node `from` using the engine's algorithm. Null means there is no Node in that direction Parameters from:Node the node to start traversal from dir:Direction the direction of traversal Returns:Node the subsequent node in the specified direction or null if none Exceptions NullPointerException: if there is no algorithm

public final Node select(Node from, Direction dir)

Returns the node that is in the direction dir starting from the Node from using the engine's algorithm. Null means there is no Node in that direction

Parameters

from:Node: the node to start traversal from
dir:Direction: the direction of traversal

Returns:Node

the subsequent node in the specified direction or null if none

Exceptions

NullPointerException:: if there is no algorithm

selectFirst	back to summary
public final Node selectFirst() Returns the first node in this engine's context (scene/parent) using the engine's algorithm. This can be null only if there are no traversable nodes Returns:Node The first node or null if none exists Exceptions NullPointerException: if there is no algorithm

selectFirst

back to summary

public final Node selectFirst()

Returns the first node in this engine's context (scene/parent) using the engine's algorithm. This can be null only if there are no traversable nodes

Returns:Node

The first node or null if none exists

Exceptions

NullPointerException:: if there is no algorithm

selectLast	back to summary
public final Node selectLast() Returns the last node in this engine's context (scene/parent) using the engine's algorithm. This can be null only if there are no traversable nodes Returns:Node The last node or null if none exists Exceptions NullPointerException: if there is no algorithm

selectLast

back to summary

public final Node selectLast()

Returns the last node in this engine's context (scene/parent) using the engine's algorithm. This can be null only if there are no traversable nodes

Returns:Node

The last node or null if none exists

Exceptions

NullPointerException:: if there is no algorithm

com.sun.javafx.scene.traversal back to summary

private abstract Class TraversalEngine.BaseEngineContext

Class Inheritance

extends Object
implements TraversalContext

java.lang.Object
com.sun.javafx.scene.traversal.TraversalEngine.BaseEngineContext

All Implemented Interfaces

com.sun.javafx.scene.traversal.TraversalContext

Known Direct Subclasses

com.sun.javafx.scene.traversal.TraversalEngine.EngineContext, com.sun.javafx.scene.traversal.TraversalEngine.TempEngineContext

The base class for all engine contexts

Constructor Summary

Access	Constructor and Description
private	BaseEngineContext()

Method Summary

Modifier and Type	Method and Description
private void	addFocusableChildrenToList(List<Node> list, Parent parent)
public List<Node>	getAllTargetNodes() Implements com.sun.javafx.scene.traversal.TraversalContext.getAllTargetNodes. Returns all traversable nodes in the context's (engine's) root
public Bounds	getSceneLayoutBounds(Node n) Implements com.sun.javafx.scene.traversal.TraversalContext.getSceneLayoutBounds. Returns layout bounds of the Node in the relevant (Sub)Scene.
public Node	selectFirstInParent(Parent parent) Implements com.sun.javafx.scene.traversal.TraversalContext.selectFirstInParent. If the TraversalEngine does not want to handle traversal inside some inner child (Parent), it can use this method to apply default algorithm inside that Parent and return the first Node
public Node	selectInSubtree(Parent subTreeRoot, Node from, Direction dir) Implements com.sun.javafx.scene.traversal.TraversalContext.selectInSubtree. If the TraversalEngine does not want to handle traversal inside some inner child (Parent), it can use this method to apply default algorithm inside that Parent and return the next Node within the Parent or null if there's no successor.
public Node	selectLastInParent(Parent parent) Implements com.sun.javafx.scene.traversal.TraversalContext.selectLastInParent. If the TraversalEngine does not want to handle traversal inside some inner child (Parent), it can use this method to apply default algorithm inside that Parent and return the last Node

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

BaseEngineContext	back to summary
private BaseEngineContext()

Method Detail

addFocusableChildrenToList	back to summary
private void addFocusableChildrenToList(List<Node> list, Parent parent)

getAllTargetNodes	back to summary
public List<Node> getAllTargetNodes() Implements com.sun.javafx.scene.traversal.TraversalContext.getAllTargetNodes. Returns all traversable nodes in the context's (engine's) root Annotations @Override

getAllTargetNodes

back to summary

public List<Node> getAllTargetNodes()

Implements com.sun.javafx.scene.traversal.TraversalContext.getAllTargetNodes.

Returns all traversable nodes in the context's (engine's) root

Annotations

@Override

getSceneLayoutBounds	back to summary
public Bounds getSceneLayoutBounds(Node n) Implements com.sun.javafx.scene.traversal.TraversalContext.getSceneLayoutBounds. Doc from com.sun.javafx.scene.traversal.TraversalContext.getSceneLayoutBounds. Returns layout bounds of the Node in the relevant (Sub)Scene. Note that these bounds are the most important for traversal as they define the final position within the scene. Annotations @Override

getSceneLayoutBounds

back to summary

public Bounds getSceneLayoutBounds(Node n)

Implements com.sun.javafx.scene.traversal.TraversalContext.getSceneLayoutBounds.

Doc from com.sun.javafx.scene.traversal.TraversalContext.getSceneLayoutBounds.

Returns layout bounds of the Node in the relevant (Sub)Scene. Note that these bounds are the most important for traversal as they define the final position within the scene.

Annotations

@Override

selectFirstInParent	back to summary
public Node selectFirstInParent(Parent parent) Implements com.sun.javafx.scene.traversal.TraversalContext.selectFirstInParent. Doc from com.sun.javafx.scene.traversal.TraversalContext.selectFirstInParent. If the TraversalEngine does not want to handle traversal inside some inner child (Parent), it can use this method to apply default algorithm inside that Parent and return the first Node Annotations @Override

selectFirstInParent

back to summary

public Node selectFirstInParent(Parent parent)

Implements com.sun.javafx.scene.traversal.TraversalContext.selectFirstInParent.

Doc from com.sun.javafx.scene.traversal.TraversalContext.selectFirstInParent.

If the TraversalEngine does not want to handle traversal inside some inner child (Parent), it can use this method to apply default algorithm inside that Parent and return the first Node

Annotations

@Override

selectInSubtree	back to summary
public Node selectInSubtree(Parent subTreeRoot, Node from, Direction dir) Implements com.sun.javafx.scene.traversal.TraversalContext.selectInSubtree. Doc from com.sun.javafx.scene.traversal.TraversalContext.selectInSubtree. If the TraversalEngine does not want to handle traversal inside some inner child (Parent), it can use this method to apply default algorithm inside that Parent and return the next Node within the Parent or null if there's no successor. Annotations @Override

selectInSubtree

back to summary

public Node selectInSubtree(Parent subTreeRoot, Node from, Direction dir)

Implements com.sun.javafx.scene.traversal.TraversalContext.selectInSubtree.

Doc from com.sun.javafx.scene.traversal.TraversalContext.selectInSubtree.

If the TraversalEngine does not want to handle traversal inside some inner child (Parent), it can use this method to apply default algorithm inside that Parent and return the next Node within the Parent or null if there's no successor.

Annotations

@Override

selectLastInParent	back to summary
public Node selectLastInParent(Parent parent) Implements com.sun.javafx.scene.traversal.TraversalContext.selectLastInParent. Doc from com.sun.javafx.scene.traversal.TraversalContext.selectLastInParent. If the TraversalEngine does not want to handle traversal inside some inner child (Parent), it can use this method to apply default algorithm inside that Parent and return the last Node Annotations @Override

selectLastInParent

back to summary

public Node selectLastInParent(Parent parent)

Implements com.sun.javafx.scene.traversal.TraversalContext.selectLastInParent.

Doc from com.sun.javafx.scene.traversal.TraversalContext.selectLastInParent.

If the TraversalEngine does not want to handle traversal inside some inner child (Parent), it can use this method to apply default algorithm inside that Parent and return the last Node

Annotations

@Override

com.sun.javafx.scene.traversal back to summary

private final Class TraversalEngine.EngineContext

Class Inheritance

extends BaseEngineContext

java.lang.Object
com.sun.javafx.scene.traversal.TraversalEngine.BaseEngineContext
com.sun.javafx.scene.traversal.TraversalEngine.EngineContext

Constructor Summary

Access	Constructor and Description
private	EngineContext()

Method Summary

Modifier and Type	Method and Description
public Parent	getRoot() Implements com.sun.javafx.scene.traversal.TraversalContext.getRoot. The root for this context, Traversal should be done only within the root

Inherited from com.sun.javafx.scene.traversal.TraversalEngine.BaseEngineContext:: getAllTargetNodes getSceneLayoutBounds selectFirstInParent selectInSubtree selectLastInParent

Constructor Detail

EngineContext	back to summary
private EngineContext()

Method Detail

getRoot	back to summary
public Parent getRoot() Implements com.sun.javafx.scene.traversal.TraversalContext.getRoot. Doc from com.sun.javafx.scene.traversal.TraversalContext.getRoot. The root for this context, Traversal should be done only within the root Annotations @Override

getRoot

back to summary

public Parent getRoot()

Implements com.sun.javafx.scene.traversal.TraversalContext.getRoot.

Doc from com.sun.javafx.scene.traversal.TraversalContext.getRoot.

The root for this context, Traversal should be done only within the root

Annotations

@Override

com.sun.javafx.scene.traversal back to summary

private final Class TraversalEngine.TempEngineContext

Class Inheritance

extends BaseEngineContext

java.lang.Object
com.sun.javafx.scene.traversal.TraversalEngine.BaseEngineContext
com.sun.javafx.scene.traversal.TraversalEngine.TempEngineContext

Field Summary

Modifier and Type	Field and Description
private Parent	root

Constructor Summary

Access	Constructor and Description
private	TempEngineContext()

Method Summary

Modifier and Type	Method and Description
public Parent	getRoot() Implements com.sun.javafx.scene.traversal.TraversalContext.getRoot. The root for this context, Traversal should be done only within the root
public void	setRoot(Parent root)

Inherited from com.sun.javafx.scene.traversal.TraversalEngine.BaseEngineContext:: getAllTargetNodes getSceneLayoutBounds selectFirstInParent selectInSubtree selectLastInParent

Field Detail

root	back to summary
private Parent root

Constructor Detail

TempEngineContext	back to summary
private TempEngineContext()

Method Detail

getRoot	back to summary
public Parent getRoot() Implements com.sun.javafx.scene.traversal.TraversalContext.getRoot. Doc from com.sun.javafx.scene.traversal.TraversalContext.getRoot. The root for this context, Traversal should be done only within the root Annotations @Override

getRoot

back to summary

public Parent getRoot()

Implements com.sun.javafx.scene.traversal.TraversalContext.getRoot.

Doc from com.sun.javafx.scene.traversal.TraversalContext.getRoot.

The root for this context, Traversal should be done only within the root

Annotations

@Override

setRoot	back to summary
public void setRoot(Parent root)

public abstract Class TraversalEngine

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private abstract Class TraversalEngine.BaseEngineContext

Constructor Summary

Method Summary

Constructor Detail

Method Detail

private final Class TraversalEngine.EngineContext

Constructor Summary

Method Summary

Constructor Detail

Method Detail

private final Class TraversalEngine.TempEngineContext

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail