metadone.client.display.Engine Interface Reference

Inheritance diagram for metadone.client.display.Engine:

List of all members.

Public Member Functions
Context	getContext ()
Engine	getParent ()
List<?extends Engine >	getChildren ()
public< C > Component<?extends C >	buildComponent (Class< C > clComp, boolean active)
public< C > Component<?extends C >	getComponent (Class< C > clComp)
boolean	isClassSupported (Class<?> clComp)
void	dispose ()
boolean	isActive ()
void	notifyChildChanged (Engine child)
void	debugEngineTreeGraphViz (Appendable out, boolean recursive, int verbose) throws IOException

---

Detailed Description

The engine interface.

Author:

kma

---

Member Function Documentation

public<C> Component<? extends C> metadone.client.display.Engine.buildComponent	(	Class< C >	clComp,
		boolean	active
	)

Builds a component.

The component is not managed by this class.

Parameters:

clComp	The class denoting the component type to build (usually Widget.class, JComponent.class, etc...)
active	Whether to activate the engine when building

Returns:

The component to display

Implemented in metadone.client.grasyla2.GrasylaEngine.

Referenced by metadone.client.MetadoneDesktopPane.EngineObserver.start().

void metadone.client.display.Engine.debugEngineTreeGraphViz	(	Appendable	out,
		boolean	recursive,
		int	verbose
	)		throws IOException

Prints the children of this engine.

The output is valid for GraphViz. It consists of a node representing this engine and optional edges to the children nodes.

Parameters:

out	The output
rescursive	Indicates whether the call is recursive
verbose	The verbose level

Implemented in metadone.client.grasyla2.GrasylaEngine.

Referenced by metadone.client.actions.DebugEngineAction.actionPerformed().

void metadone.client.display.Engine.dispose

(

)

Disposes this engine.

Implemented in metadone.client.grasyla2.GrasylaEngine.

Referenced by metadone.client.grasyla2.GrasylaEngine.removeChild(), metadone.client.MetadoneDesktopPane.EngineObserver.start(), and metadone.client.MetadoneDesktopPane.EngineObserver.stop().

List<? extends Engine> metadone.client.display.Engine.getChildren

(

)

Gets the children engines.

Returns:

The children engines (unmodifiable list)

Implemented in metadone.client.grasyla2.GrasylaEngine.

public<C> Component<? extends C> metadone.client.display.Engine.getComponent

(

Class< C >

clComp

)

Gets the built component.

Returns:

The built component or null if nothing has been built

Implemented in metadone.client.grasyla2.GrasylaEngine.

Referenced by metadone.client.MetadoneDesktopPane.EngineObserver.trigger().

Context metadone.client.display.Engine.getContext

(

)

Gets the context.

Returns:

The context

Implemented in metadone.client.grasyla2.GrasylaEngine.

Referenced by metadone.client.actions.ConcreteObjectEditAction.actionPerformed(), metadone.client.actions.ConcreteObjectCreateAction.actionPerformed(), metadone.client.MetadoneDesktopPane.addNewFrame(), metadone.client.MetadoneDesktopPane.EngineObserver.start(), metadone.client.MetadoneDesktopPane.EngineObserver.stop(), metadone.client.MetadoneDesktopPane.updateModelMenuItems(), and metadone.client.MetadoneDesktopPane.updatePopupMenuItems().

Engine metadone.client.display.Engine.getParent

(

)

Gets the parent engine.

Returns:

The parent engine

Implemented in metadone.client.grasyla2.GrasylaEngine.

Referenced by metadone.client.grasyla2.GrasylaEngineFactory.loopDetectInEngines().

boolean metadone.client.display.Engine.isActive

(

)

Indicates whether this engine is active.

Returns:

true iff this engine is active

Implemented in metadone.client.grasyla2.GrasylaEngine.

Referenced by metadone.client.MetadoneDesktopPane.EngineObserver.trigger().

boolean metadone.client.display.Engine.isClassSupported

(

Class<?>

clComp

)

Tests if the given class can be used by this component.

Parameters:

clComp

The component class

Returns:

true iff the class is supported

Implemented in metadone.client.grasyla2.base.GrasylaEngineTyped< T >, metadone.client.grasyla2.GrasylaEngine, and metadone.client.grasyla2.visuallibrary.GraphEngine.

void metadone.client.display.Engine.notifyChildChanged

(

Engine

child

)

Called by the active child to indicate that its component has changed.

Parameters:

child

The child engine

Implemented in metadone.client.grasyla2.GrasylaEngine.

Referenced by metadone.client.grasyla2.GrasylaEngine.GrasylaEngine().

---

The documentation for this interface was generated from the following file:

• metadone_bundle_client/src/metadone/client/display/Engine.java