Package org.praxislive.ide.pxr.graph

Class GraphEditor

java.lang.Object

org.praxislive.ide.pxr.graph.GraphEditor

All Implemented Interfaces:

RootEditor

public final class GraphEditor
extends Object
implements RootEditor

Nested Class Summary

Nested classes/interfaces inherited from interface org.praxislive.ide.pxr.spi.RootEditor

RootEditor.Context, RootEditor.Provider, RootEditor.ToolAction

Constructor Summary

Constructors

Constructor	Description
GraphEditor(RootProxy proxy, RootEditor.Context context)

Method Summary

Modifier and Type	Method	Description
void	componentActivated()	Hook called when the containing top component is activated.
void	dispose()	Hook called when the editor component is being uninstalled and disposed of.
List<Action>	getActions()	Get a list of action to be added to the top component toolbar.
JComponent	getEditorComponent()	Acquire the main editor component.
org.openide.util.Lookup	getLookup()	Get the editor lookup.
boolean	requestFocus()	Request focus of the editor component.
Set<RootEditor.ToolAction>	supportedToolActions()	Return the set of tool actions this editor wishes to support.
void	sync()	Hook called to ensure any data in the editor is synced to the underlying model.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.praxislive.ide.pxr.spi.RootEditor

componentDeactivated, componentHidden, componentShowing, getUndoRedo

Constructor Details

GraphEditor

public GraphEditor(RootProxy proxy,
 RootEditor.Context context)

Method Details

componentActivated

public void componentActivated()

Description copied from interface: RootEditor

Hook called when the containing top component is activated. See TopComponent.componentActivated().

The default implementation does nothing.

Specified by:

componentActivated in interface RootEditor

dispose

public void dispose()

Description copied from interface: RootEditor

Hook called when the editor component is being uninstalled and disposed of.

The default implementation does nothing.

Specified by:

dispose in interface RootEditor

getEditorComponent

public JComponent getEditorComponent()

Description copied from interface: RootEditor

Acquire the main editor component. This component will be installed in the central pane of the root editor top component. This method should always return the same instance.

Specified by:

getEditorComponent in interface RootEditor

Returns:

main editor component

getLookup

public org.openide.util.Lookup getLookup()

Description copied from interface: RootEditor

Get the editor lookup. This lookup will be merged into the top component lookup.

The top component lookup will already reflect the main context explorer manager from RootEditor.Context.explorerManager().

The default implementation returns an empty lookup.

Specified by:

getLookup in interface RootEditor

Returns:

editor lookup

getActions

public List<Action> getActions()

Description copied from interface: RootEditor

Get a list of action to be added to the top component toolbar.

The default implementation returns an empty list.

Specified by:

getActions in interface RootEditor

Returns:

list of toolbar actions

requestFocus

public boolean requestFocus()

Description copied from interface: RootEditor

Request focus of the editor component. This method is called by the default implementation of RootEditor.componentActivated(). This method will also be called while the component is activated to return focus to the RootEditor component (eg. from tool actions). The default implementation calls JComponent.requestFocusInWindow() on the editor component.

Specified by:

requestFocus in interface RootEditor

Returns:

false if the request is guaranteed to fail, true if it is likely to succeed.

supportedToolActions

public Set<RootEditor.ToolAction> supportedToolActions()

Description copied from interface: RootEditor

Return the set of tool actions this editor wishes to support. The default implementation returns EnumSet.noneOf(ToolAction.class). To install all default tool actions, return EnumSet.allOf(ToolActions.class) or otherwise filter the returned set.

Specified by:

supportedToolActions in interface RootEditor

Returns:

support tool actions

sync

public void sync()

Description copied from interface: RootEditor

Hook called to ensure any data in the editor is synced to the underlying model. Will be called prior to saving, and any other time the model needs to be up-to-date.

The default implementation does nothing.

Specified by:

sync in interface RootEditor