ilog.views.appframe.docview
Interface IlvMDIViewContainer

All Superinterfaces:

ActionHandler, ActionListener, EventListener, IlvPropertyManager, IlvViewContainer

All Known Implementing Classes:

IlvInternalFrame, IlvMDITab

public interface IlvMDIViewContainer
extends IlvViewContainer

Defines view containers attached to one IlvDocument instance, like internal frames or a pane in a tabbed pane.

See Also:

IlvDocumentViewConfiguration

Field Summary

static String	CLOSE_ALL_WINDOWS_CMD Action command key for the action that closes all MDI child windows.
static String	CLOSE_WINDOW_CMD Action command key for the action that closes the container.
static String	NEXT_WINDOW_CMD Action command key for the action that activates the next window to the current window in the window history list.
static String	OWN_TITLE_PROPERTY Bound property name that specifies whether the view container provides its own title or whether this title is set taking into account the title of its associated document.
static String	PREVIOUS_WINDOW_CMD Action command key for the action that activates the previous window to the current window in the window history list.
static String	TITLE_PROPERTY Bound property name for the title property.

Fields inherited from interface ilog.views.appframe.docview.IlvViewContainer

ACTIVE_VIEW_PROPERTY, APPLICATION_PROPERTY, CONFIGURATION_NAME_PROPERTY, CONTAINER_TEMPLATE_PROPERTY, DOCUMENT_PROPERTY, DOCUMENT_TEMPLATE_PROPERTY, DOCUMENT_VIEWS_PROPERTY, VISIBILITY_PROPERTY

Method Summary

boolean	addViews(IlvDocumentView[] views) Adds the specified views to the container.
boolean	builtInViews() Determines whether this container already contains views when they are created.
boolean	close() Closes the container.
String	getContainerTitle() Returns the title of the container.
void	setContainerTitle(String title) Sets a new title to the container.

Methods inherited from interface ilog.views.appframe.docview.IlvViewContainer

activate, getViews, isContainerVisible, setContainerVisible

Methods inherited from interface ilog.views.appframe.event.ActionHandler

isProcessingAction, updateAction

Methods inherited from interface java.awt.event.ActionListener

actionPerformed

Methods inherited from interface ilog.views.appframe.util.IlvPropertyManager

addPropertyChangeListener, getProperty, removePropertyChangeListener, setProperty

Field Detail

TITLE_PROPERTY

static final String TITLE_PROPERTY

Bound property name for the title property.

See Also:

Constant Field Values

OWN_TITLE_PROPERTY

static final String OWN_TITLE_PROPERTY

Bound property name that specifies whether the view container provides its own title or whether this title is set taking into account the title of its associated document.
If the value of the property is equal to Boolean.TRUE, the title of the view container will not automatically be set to the title of its associated document. Otherwise, the title of the view container is updated according to the title of the document.
By default, this property is not set.

See Also:

Constant Field Values

CLOSE_ALL_WINDOWS_CMD

static final String CLOSE_ALL_WINDOWS_CMD

Action command key for the action that closes all MDI child windows. This action should be processed by the class implementing this interface.

See Also:

Constant Field Values

CLOSE_WINDOW_CMD

static final String CLOSE_WINDOW_CMD

Action command key for the action that closes the container. This action should be processed by the class implementing this interface.

See Also:

Constant Field Values

PREVIOUS_WINDOW_CMD

static final String PREVIOUS_WINDOW_CMD

Action command key for the action that activates the previous window to the current window in the window history list. This action should be processed by the class implementing this interface.

See Also:

Constant Field Values

NEXT_WINDOW_CMD

static final String NEXT_WINDOW_CMD

Action command key for the action that activates the next window to the current window in the window history list. This action should be processed by the class implementing this interface.

See Also:

Constant Field Values

Method Detail

close

boolean close()

Closes the container.

Returns:

true if the container could be closed; false otherwise.

getContainerTitle

String getContainerTitle()

Returns the title of the container. The implementation of this method should return the value of the TITLE_PROPERTY.

Returns:

The title of the container.

See Also:

setContainerTitle(java.lang.String)

setContainerTitle

void setContainerTitle(String title)

Sets a new title to the container.
The implementation of this method should set the TITLE_PROPERTY to the specified title.

Parameters:

title - The new title of the container.

See Also:

getContainerTitle()

builtInViews

boolean builtInViews()

Determines whether this container already contains views when they are created.
If it already contains views, it is asked to provide the built-in views with the IlvViewContainer.getViews() method.
Otherwise, the document template associated with this container provides the document views to the container with the method addViews(ilog.views.appframe.docview.IlvDocumentView[]).

Returns:

true if the container already contains document views when created; false otherwise.

See Also:

IlvViewContainer.getViews(), addViews(ilog.views.appframe.docview.IlvDocumentView[])

addViews

boolean addViews(IlvDocumentView[] views)

Adds the specified views to the container.

Parameters:

views - The views to add.

Returns:

true if the views could be added to the container; false otherwise.