org.eclipse.gef4.mvc.fx.policies

Class FXTraverseOnTypePolicy

java.lang.Object

org.eclipse.gef4.mvc.policies.AbstractPolicy<VR>

org.eclipse.gef4.mvc.policies.AbstractInteractionPolicy<javafx.scene.Node>

org.eclipse.gef4.mvc.fx.policies.AbstractFXInteractionPolicy

org.eclipse.gef4.mvc.fx.policies.FXTraverseOnTypePolicy

All Implemented Interfaces:

IAdaptable.Bound<IVisualPart<javafx.scene.Node,? extends javafx.scene.Node>>, IFXOnTypePolicy, IPolicy<javafx.scene.Node>

public class FXTraverseOnTypePolicy
extends AbstractFXInteractionPolicy
implements IFXOnTypePolicy

The FXTraverseOnTypePolicy implements focus traversal via keyboard input.

Constructor Summary

Constructors

Constructor and Description
FXTraverseOnTypePolicy()

Method Summary

Modifier and Type	Method and Description
protected IContentPart<javafx.scene.Node,? extends javafx.scene.Node>	findInnerMostContentPart(IContentPart<javafx.scene.Node,? extends javafx.scene.Node> part) Returns the inner most IContentPart child within the part hierarchy of the given IContentPart.
protected IContentPart<javafx.scene.Node,? extends javafx.scene.Node>	findNextContentPart(IContentPart<javafx.scene.Node,? extends javafx.scene.Node> current) Determines the next IContentPart to which keyboard focus is assigned, depending on the currently focused IContentPart.
protected IContentPart<javafx.scene.Node,? extends javafx.scene.Node>	findPreviousContentPart(IContentPart<javafx.scene.Node,? extends javafx.scene.Node> current) Determines the previous IContentPart to which keyboard focus is assigned, depending on the currently focused IContentPart.
void	pressed(javafx.scene.input.KeyEvent event) This callback method is invoked when the user presses a key while the host has keyboard focus.
void	released(javafx.scene.input.KeyEvent event) This callback method is invoked when the user releases a key while the host has keyboard focus.
void	typed(javafx.scene.input.KeyEvent event) This callback method is invoked when the user types a unicode key while the host has keyboard focus.
void	unfocus() This callback method is invoked when the viewer loses its focus while a key press/release gesture is running.

Methods inherited from class org.eclipse.gef4.mvc.fx.policies.AbstractFXInteractionPolicy

isRegistered, isRegisteredForHost

Methods inherited from class org.eclipse.gef4.mvc.policies.AbstractInteractionPolicy

commit, init, restoreRefreshVisuals, rollback, storeAndDisableRefreshVisuals

Methods inherited from class org.eclipse.gef4.mvc.policies.AbstractPolicy

getAdaptable, getHost, setAdaptable

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.gef4.mvc.policies.IPolicy

getHost

Methods inherited from interface org.eclipse.gef4.common.adapt.IAdaptable.Bound

getAdaptable, setAdaptable

Constructor Detail

FXTraverseOnTypePolicy

public FXTraverseOnTypePolicy()

Method Detail

findInnerMostContentPart

protected IContentPart<javafx.scene.Node,? extends javafx.scene.Node> findInnerMostContentPart(IContentPart<javafx.scene.Node,? extends javafx.scene.Node> part)

Returns the inner most IContentPart child within the part hierarchy of the given IContentPart. If the given IContentPart does not have any IContentPart children, then the given IContentPart is returned.

Parameters:

part - The IContentPart for which to determine the inner most IContentPart child.

Returns:

The inner most IContentPart child within the part hierarchy of the given IContentPart.

findNextContentPart

protected IContentPart<javafx.scene.Node,? extends javafx.scene.Node> findNextContentPart(IContentPart<javafx.scene.Node,? extends javafx.scene.Node> current)

Determines the next IContentPart to which keyboard focus is assigned, depending on the currently focused IContentPart.

The first content part child of the given focus part is returned as the next part if a content part child is available.

The next content part sibling of the given focus part is returned as the next part if a content part sibling is available. When one sibling list ends, the search continues with the parent's siblings until it reaches the root of the hierarchy.

If the next content part cannot be determined, null is returned.

Parameters:

current - The currently focused IContentPart.

Returns:

The next IContentPart to which keyboard focus is assigned, or null if no subsequent IContentPart could be determined.

findPreviousContentPart

protected IContentPart<javafx.scene.Node,? extends javafx.scene.Node> findPreviousContentPart(IContentPart<javafx.scene.Node,? extends javafx.scene.Node> current)

Determines the previous IContentPart to which keyboard focus is assigned, depending on the currently focused IContentPart.

At first, the previous content part sibling of the given focus part is determined. If a siblings list ends, the search continues with the parent's siblings.

The inner most content part child of the previous content part sibling is returned as the previous content part, or null if no previous content part sibling could be found.

Parameters:

current - The currently focused IContentPart.

Returns:

The previous IContentPart to which keyboard focus is assigned, or null if no previous IContentPart could be determined.

pressed

public void pressed(javafx.scene.input.KeyEvent event)

Description copied from interface: IFXOnTypePolicy

This callback method is invoked when the user presses a key while the host has keyboard focus.

Specified by:

pressed in interface IFXOnTypePolicy

Parameters:

event - The original KeyEvent.

released

public void released(javafx.scene.input.KeyEvent event)

Description copied from interface: IFXOnTypePolicy

This callback method is invoked when the user releases a key while the host has keyboard focus.

Specified by:

released in interface IFXOnTypePolicy

Parameters:

event - The original KeyEvent.

typed

public void typed(javafx.scene.input.KeyEvent event)

Description copied from interface: IFXOnTypePolicy

This callback method is invoked when the user types a unicode key while the host has keyboard focus.

Specified by:

typed in interface IFXOnTypePolicy

Parameters:

event - The original KeyEvent.

unfocus

public void unfocus()

Description copied from interface: IFXOnTypePolicy

This callback method is invoked when the viewer loses its focus while a key press/release gesture is running.

Specified by:

unfocus in interface IFXOnTypePolicy