ilog.views.appframe.docview
Interface IlvViewContainer

All Superinterfaces:

ActionHandler, ActionListener, EventListener, IlvPropertyManager

All Known Subinterfaces:

IlvMDIViewContainer

All Known Implementing Classes:

IlvAbstractStaticViewContainer, IlvDefaultStaticViewContainer, IlvInternalFrame, IlvMDITab

public interface IlvViewContainer
extends ActionHandler, IlvPropertyManager

Defines objects that contain document views.
When a document template creates document views to associate with a document, it creates first a view container that will contain those views.
In a Swing application, a view container can be an internal frame, a pane contained within a tabbed pane or panel inserted into the main window, like a project pane. Two kinds of view container must be distinguished.

• MDI view containers that are created for each new document. One view container corresponds to one document instance. Such view containers are internal frames or tab panes in an MDI Swing application. They are instantiated when creating a new document with a document template using an IlvMDIContainerTemplate.
• Static view containers that are created when initializing the main window of the application. As an example, they can be a panel inserted in the main window like a project pane or an inspector component showing the properties of the selected element of the active document.
  To have its document view(s) connected to the active document of the application, a static view container must be registered with the main window of the application using the method IlvMainWindow.registerStaticContainer(java.lang.String, ilog.views.appframe.docview.IlvViewContainer).

Processing action events
The IlvViewContainer class implements the ActionHandler interface for processing action events triggered by the application.
When a document view becomes active in the application, its view container is also activated. The active view is registered with the application as a new action handler, as is the view container, but with a lower priority. Action updates or events that are not processed by the active view can be processed by the view container. When the view container is deactivated, it is removed from the list of action handlers of the application.

An implementation of the IlvDocument interface can handle action events in the implementation of the methods:

• ActionListener.actionPerformed(java.awt.event.ActionEvent)
• ActionHandler.updateAction(javax.swing.Action)
• ActionHandler.isProcessingAction(java.lang.String)

Field Summary

static String	ACTIVE_VIEW_PROPERTY Bound property name for the active view of the container.
static String	APPLICATION_PROPERTY Bound property name for the application of the view container.
static String	CONFIGURATION_NAME_PROPERTY Bound property name for the name of the configuration that creates the view container.
static String	CONTAINER_TEMPLATE_PROPERTY Bound property name for the container template of the view container.
static String	DOCUMENT_PROPERTY Bound property name for the document of the view container.
static String	DOCUMENT_TEMPLATE_PROPERTY Bound property name for the document template associated with the document.
static String	DOCUMENT_VIEWS_PROPERTY Bound property name for the views contained within the view container.
static String	VISIBILITY_PROPERTY Bound property name for the visibility of the view container.

Method Summary

void	activate() Sets the container active.
IlvDocumentView[]	getViews() Returns the document views of this container.
boolean	isContainerVisible() Determines whether this view container is visible.
void	setContainerVisible(boolean visible) Shows or hides this view container depending on the value of the visible parameter.

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

DOCUMENT_TEMPLATE_PROPERTY

static final String DOCUMENT_TEMPLATE_PROPERTY

Bound property name for the document template associated with the document.

See Also:

Constant Field Values

APPLICATION_PROPERTY

static final String APPLICATION_PROPERTY

Bound property name for the application of the view container.

See Also:

Constant Field Values

DOCUMENT_PROPERTY

static final String DOCUMENT_PROPERTY

Bound property name for the document of the view container.

See Also:

Constant Field Values

CONFIGURATION_NAME_PROPERTY

static final String CONFIGURATION_NAME_PROPERTY

Bound property name for the name of the configuration that creates the view container.

See Also:

Constant Field Values

DOCUMENT_VIEWS_PROPERTY

static final String DOCUMENT_VIEWS_PROPERTY

Bound property name for the views contained within the view container. The value of the property has the type IlvDocumentView[].

See Also:

Constant Field Values

ACTIVE_VIEW_PROPERTY

static final String ACTIVE_VIEW_PROPERTY

Bound property name for the active view of the container. If the value of the property is equal to Boolean.TRUE, the container will be active. Otherwise, the container is not active.

See Also:

Constant Field Values

CONTAINER_TEMPLATE_PROPERTY

static final String CONTAINER_TEMPLATE_PROPERTY

Bound property name for the container template of the view container.

See Also:

Constant Field Values

VISIBILITY_PROPERTY

static final String VISIBILITY_PROPERTY

Bound property name for the visibility of the view container. The value of this property is Boolean.TRUE if the view container is visible; Boolean.FALSE otherwise.

See Also:

Constant Field Values

Method Detail

getViews

IlvDocumentView[] getViews()

Returns the document views of this container.

Returns:

The array of views of this view container.

activate

void activate()

Sets the container active.

isContainerVisible

boolean isContainerVisible()

Determines whether this view container is visible.

Returns:

true if the container is visible; false otherwise.

See Also:

setContainerVisible(boolean)

setContainerVisible

void setContainerVisible(boolean visible)

Shows or hides this view container depending on the value of the visible parameter.

Parameters:

visible - if true the view container is shown; if false the view container is hidden.

See Also:

isContainerVisible()