ptolemy.vergil.actor

Interface ActorInteractionAddon

public interface ActorInteractionAddon

An interface for defining additional gui interaction for specific actor types. Once the interface is implemented, it can be used by adding an _actorInteractionAddon parameter to the configuration and setting the value to the name of the class that implements this interface.

Since:

Ptolemy II 10.0

Version:

$Id: ActorInteractionAddon.java 70398 2014-10-22 23:44:32Z cxh $

Author:

Lyle Holsinger

Accepted Rating:

red (lholsing)

Proposed Rating:

red (lholsing)

Method Summary

Modifier and Type	Method and Description
ActorController	getControllerInstance(GraphController controller) Get an instance of the ActorController for a given actor.
ActorController	getControllerInstance(GraphController controller, boolean fullAccess) Get an instance of the ActorController for a given actor.
boolean	isActorOfInterestForAddonController(NamedObj actor) Determine of a given actor is of interest for a desired action.
boolean	isActorOfInterestForLookInside(NamedObj actor) Determine of a given actor is of interest for a desired action.
boolean	isActorOfInterestForOpenInstance(NamedObj actor) Determine of a given actor is of interest for a desired action.
void	lookInsideAction(FigureAction figureAction, NamedObj actor) The action to be taken when looking inside an actor.
void	openInstanceAction(FigureAction figureAction, NamedObj actor) The action to be taken when looking inside an actor.

Method Detail

isActorOfInterestForLookInside

boolean isActorOfInterestForLookInside(NamedObj actor)

Determine of a given actor is of interest for a desired action.

Parameters:

actor - The actor of interest.

Returns:

True if the actor is of interest for the "Look Inside" action for actors, False otherwise.

lookInsideAction

void lookInsideAction(FigureAction figureAction,
                      NamedObj actor)
               throws IllegalActionException,
                      NameDuplicationException

The action to be taken when looking inside an actor.

Parameters:

figureAction - The FigureAction from which the call is being made.

actor - The actor being opened.

Throws:

IllegalActionException - If the container is incompatible with this attribute.

NameDuplicationException - If the name coincides with an attribute already in the container.

isActorOfInterestForOpenInstance

boolean isActorOfInterestForOpenInstance(NamedObj actor)

Determine of a given actor is of interest for a desired action.

Parameters:

actor - The actor of interest.

Returns:

True if the actor is of interest for the "Open Instance" action for actors, False otherwise.

openInstanceAction

void openInstanceAction(FigureAction figureAction,
                        NamedObj actor)
                 throws IllegalActionException,
                        NameDuplicationException

The action to be taken when looking inside an actor.

Parameters:

figureAction - The FigureAction from which the call is being made.

actor - The actor being opened.

Throws:

IllegalActionException - If the container is incompatible with this attribute.

NameDuplicationException - If the name coincides with an attribute already in the container.

getControllerInstance

ActorController getControllerInstance(GraphController controller)

Get an instance of the ActorController for a given actor. This assumes Full access.

Parameters:

controller - The associated graph controller.

Returns:

An instance of the appropriate controller.

getControllerInstance

ActorController getControllerInstance(GraphController controller,
                                      boolean fullAccess)

Get an instance of the ActorController for a given actor.

Parameters:

controller - The associated graph controller.

fullAccess - Indication if the controller should be instantiated with Full access.

Returns:

An instance of the appropriate controller.

isActorOfInterestForAddonController

boolean isActorOfInterestForAddonController(NamedObj actor)

Determine of a given actor is of interest for a desired action.

Parameters:

actor - The actor of interest.

Returns:

True if the actor is of interest for use of a special controller, False otherwise.