oracle.ide.explorer
Interface Explorer

All Superinterfaces:

ControllerProvider, Helpable, View

All Known Subinterfaces:

UICanvas, UIEditorCanvas

All Known Implementing Classes:

AbstractCanvas, AbstractExplorer

public interface Explorer

extends View

The Explorer interface provides the API for getting a GUI representation of the structure for a given Context.

Field Summary

static int	CLOSED
static int	HIDDEN
static int	SHOWN

Fields inherited from interface oracle.ide.addin.View

PROJECT_PROP, VISIBLE_PROP, WORKSPACE_PROP

Method Summary

java.lang.String	getTitle() Get the caption to use in the title bar of a hosting View.
void	setContext(Context context) (Re)initialize the contents of the gui.
void	setOwner(View host) Set the View which is to act as the host of this Explorer.
void	stateChanged(int state) Respond to a change of state between SHOWN, HIDDEN or CLOSED.

Methods inherited from interface oracle.ide.addin.View

activate, addViewListener, addViewSelectionListener, close, deactivate, getContext, getContext, getContextMenu, getGUI, getId, getSelection, getToolbar, isVisible, owner, removeViewListener, removeViewSelectionListener, setToolbarVisible, show, updateTitle, updateVisibleActions

Methods inherited from interface oracle.ide.addin.ControllerProvider

getController

Methods inherited from interface oracle.ide.help.Helpable

getHelpInfo

Field Detail

SHOWN

public static final int SHOWN

See Also:

Constant Field Values

HIDDEN

public static final int HIDDEN

See Also:

Constant Field Values

CLOSED

public static final int CLOSED

See Also:

Constant Field Values

Method Detail

setOwner

public void setOwner(View host)

Set the View which is to act as the host of this Explorer.

Parameters:

host - the View which is acting as the host.

setContext

public void setContext(Context context)

(Re)initialize the contents of the gui.

Parameters:

context - the Context to use as initialization data.

stateChanged

public void stateChanged(int state)

Respond to a change of state between SHOWN, HIDDEN or CLOSED.

Parameters:

state - the new state.

getTitle

public java.lang.String getTitle()

Get the caption to use in the title bar of a hosting View. This would typically be the short descripton of the Document being edited as found in the Context.getDocument().getShortLabel().

Returns:

the caption to use in the title bar of a hosting View.