org.jacpfx.rcp.registry

Class PerspectiveRegistry

java.lang.Object

org.jacpfx.rcp.registry.PerspectiveRegistry

public class PerspectiveRegistry
extends java.lang.Object

Created with IntelliJ IDEA. User: Andy Date: 28.05.13 Time: 21:13 Global registry with references to all perspective

Method Summary

Modifier and Type	Method and Description
static void	clearOnShutdown() clears registry on application shutdown
static org.jacpfx.api.component.Perspective<javafx.scene.Node,javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object>	findNextActivePerspective(org.jacpfx.api.component.Perspective<javafx.scene.Node,javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object> current) Returns the next active perspective.
static org.jacpfx.api.component.Perspective<javafx.scene.Node,javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object>	findPerspectiveById(java.lang.String targetId) Returns a perspective by perspectiveId
static org.jacpfx.api.component.Perspective<javafx.scene.Node,javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object>	findPerspectiveById(java.lang.String parentId, java.lang.String componentId) Returns a perspective by perspectiveId
static java.lang.String	getAndSetCurrentVisiblePerspective(java.lang.String id) Set a new perspective id and returns the current id.
static java.lang.String	getCurrentVisiblePerspective() returns the current visible perspective id.
static boolean	perspectiveContainsComponentIdInAnnotation(java.lang.String parentId, java.lang.String componentId) Checks if a specific componentId is present in defined perspective annotation.
static void	registerPerspective(org.jacpfx.api.component.Perspective<javafx.scene.Node,javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object> perspective) Registers a perspective.
static void	removePerspective(org.jacpfx.api.component.Perspective<javafx.scene.Node,javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object> perspective) Removes perspective from registry.

Methods inherited from class java.lang.Object

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

Method Detail

clearOnShutdown

public static void clearOnShutdown()

clears registry on application shutdown

getAndSetCurrentVisiblePerspective

public static java.lang.String getAndSetCurrentVisiblePerspective(java.lang.String id)

Set a new perspective id and returns the current id.

Parameters:

id, - the new perspective id

Returns:

the previous perspective id

getCurrentVisiblePerspective

public static java.lang.String getCurrentVisiblePerspective()

returns the current visible perspective id.

Returns:

the current visible perspective id

registerPerspective

public static void registerPerspective(org.jacpfx.api.component.Perspective<javafx.scene.Node,javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object> perspective)

Registers a perspective.

Parameters:

perspective, - a perspective to register

removePerspective

public static void removePerspective(org.jacpfx.api.component.Perspective<javafx.scene.Node,javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object> perspective)

Removes perspective from registry.

Parameters:

perspective, - a perspective to remove

findNextActivePerspective

public static org.jacpfx.api.component.Perspective<javafx.scene.Node,javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object> findNextActivePerspective(org.jacpfx.api.component.Perspective<javafx.scene.Node,javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object> current)

Returns the next active perspective. This can happen when a perspective was set to inactive. In this case the next underlying perspective should be displayed.

Parameters:

current - the current active perspective

Returns:

the next active perspective

findPerspectiveById

public static org.jacpfx.api.component.Perspective<javafx.scene.Node,javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object> findPerspectiveById(java.lang.String targetId)

Returns a perspective by perspectiveId

Parameters:

targetId - , the target perspective id

Returns:

a perspective

findPerspectiveById

public static org.jacpfx.api.component.Perspective<javafx.scene.Node,javafx.event.EventHandler<javafx.event.Event>,javafx.event.Event,java.lang.Object> findPerspectiveById(java.lang.String parentId,
                                                                                                                                                                            java.lang.String componentId)

Returns a perspective by perspectiveId

Parameters:

componentId - , the target perspective id

parentId - , the target workbench id

Returns:

a perspective

perspectiveContainsComponentIdInAnnotation

public static boolean perspectiveContainsComponentIdInAnnotation(java.lang.String parentId,
                                                                 java.lang.String componentId)

Checks if a specific componentId is present in defined perspective annotation. This method call assumes that a check for component instances for this perspective was already done

Parameters:

parentId - The perspective ID

componentId - The component ID

Returns:

True if component exists in perspective