org.mockcentral.editor
Interface IMockCentralEditor

public interface IMockCentralEditor

Interface for the top level editor class used for editing MockCentral configuration files. This interface specifies methods for managing and updating the editor and outline displays and handling basic editor lifecycle events.

Author:

David Hutchinson

Method Summary

java.lang.ClassLoader	getClassLoader() Returns the ClassLoader associated with this editor.
MockCentralNode	getCurrentNode() Returns the MockCentralNode currently open for editing.
java.lang.Object	getInput() Returns the editor's input.
IMockCentralNodeView	getNodeView(MockCentralNodeType nodeType) Returns the IMockCentralNodeView instance appropriate for the MockCentralNode type identified by the parameter.
java.lang.Object	getPreferenceValue(java.lang.String preferenceName) Returns the value of a prefence used by the editor.
void	loadPageFor(MockCentralNode selectedNode) Loads the appropriate editor page for the supplied MockCentralNode.
void	nodeProblemsChanged() Notification that the NodeProblem list has changed.
void	setDirty(boolean dirty) Sets the dirty value for the editor.
void	setPreference(java.lang.String preferenceName, java.lang.Object preferenceValue) Sets the value of a prefence used by the editor.

Method Detail

getInput

java.lang.Object getInput()

Returns the editor's input.

Returns:

the editor's input.

getCurrentNode

MockCentralNode getCurrentNode()

Returns the MockCentralNode currently open for editing.

Returns:

the MockCentralNode currently open for editing.

getNodeView

IMockCentralNodeView getNodeView(MockCentralNodeType nodeType)

Returns the IMockCentralNodeView instance appropriate for the MockCentralNode type identified by the parameter.

Parameters:

nodeType - the MockCentralNodeType for the node to be viewed.

Returns:

the IMockCentralNodeView class.

setDirty

void setDirty(boolean dirty)

Sets the dirty value for the editor.

Parameters:

dirty - the dirty value.

loadPageFor

void loadPageFor(MockCentralNode selectedNode)

Loads the appropriate editor page for the supplied MockCentralNode.

Parameters:

selectedNode - the MockCentralNode to be opened for editing.

nodeProblemsChanged

void nodeProblemsChanged()

Notification that the NodeProblem list has changed.

setPreference

void setPreference(java.lang.String preferenceName,
                   java.lang.Object preferenceValue)

Sets the value of a prefence used by the editor.

Parameters:

preferenceName - the name of the preference.

preferenceValue - the new value.

getPreferenceValue

java.lang.Object getPreferenceValue(java.lang.String preferenceName)

Returns the value of a prefence used by the editor.

Parameters:

preferenceName - the name of the preference.

Returns:

the value of a prefence used by the editor.

getClassLoader

java.lang.ClassLoader getClassLoader()

Returns the ClassLoader associated with this editor.

Returns:

the ClassLoader associated with this editor.