ilog.views.appframe.docview.project

Class IlvWorkspaceDocument

java.lang.Object

ilog.views.appframe.docview.IlvAbstractDocument

ilog.views.appframe.docview.IlvAbstractFileDocument

ilog.views.appframe.docview.project.IlvDataContainerDocument

ilog.views.appframe.docview.project.IlvProjectDocument

ilog.views.appframe.docview.project.IlvWorkspaceDocument

All Implemented Interfaces:

IlvDocument, IlvFileDocument, IlvStreamDocument, IlvDataContainerProvider, ActionHandler, MessageListener, IlvPropertyManager, ActionListener, EventListener

public class IlvWorkspaceDocument
extends IlvProjectDocument

Defines data container documents that are associated with IlvWorkspaceDataContainer instances. Workspace documents manage a hierarchical tree of data, like references to files, references to project files, or folders.

Field Summary

Fields inherited from class ilog.views.appframe.docview.project.IlvDataContainerDocument

DATA_CONTAINER_PROPERTY, NODE_DOCUMENTS_ATTACHED_PROPERTY

Fields inherited from class ilog.views.appframe.docview.IlvAbstractFileDocument

PATHNAME_PROPERTY

Fields inherited from class ilog.views.appframe.docview.IlvAbstractDocument

REDO_CMD, UNDO_CMD

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

FILE_FILTER_PROPERTY, MRU_PROPERTY

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

APPLICATION_PROPERTY, ATTACHED_DOCUMENTS_PROPERTY, DOCUMENT_OWNER_PROPERTY, DOCUMENT_TEMPLATE_PROPERTY, EDITABLE_PROPERTY, MODIFIED_PROPERTY, SAVEABLE_PROPERTY, TITLE_PROPERTY

Constructor Summary

Constructors

Constructor and Description
IlvWorkspaceDocument() Constructs a new IlvWorkspaceDocument document.

Method Summary

Modifier and Type	Method and Description
protected IlvDataContainer	createDataContainer(Object userData) Factory method for creating a data container to associate with this document.
protected void	initializeDataContainer(IlvDataContainer dataContainer, Object userData) Initializes the specified dataContainer.

Methods inherited from class ilog.views.appframe.docview.project.IlvProjectDocument

canOpenDocument, createDocument, endInitializeDataContainer, insertProjectReference

Methods inherited from class ilog.views.appframe.docview.project.IlvDataContainerDocument

areNodeDocumentsAttached, attachNodeDocuments, getDataContainer, getNodeTitle, getOpenDocument, initializeDocument, openDocument, readDataContainer, readDocument, readDocument, setDataContainer, setNodeTitle, writeDataContainer, writeDocument, writeDocument

Methods inherited from class ilog.views.appframe.docview.IlvAbstractFileDocument

activated, getFileDocumentTemplate, getPathName, readStreamDocument, setPathName, writeStreamDocument

Methods inherited from class ilog.views.appframe.docview.IlvAbstractDocument

actionPerformed, addActionHandler, addEdit, addPropertyChangeListener, addView, attachDocument, canRedo, canUndo, clean, documentClosed, documentClosing, getActiveView, getApplication, getDocumentTemplate, getProperty, getTitle, getUndoManager, getView, getViewCount, getViews, isModified, isProcessingAction, notifyViews, receiveMessage, redo, registerMappings, removeActionHandler, removePropertyChangeListener, removeView, removeViews, setApplication, setModified, setProperty, setTitle, undo, updateAction, updateModificationState

Methods inherited from class java.lang.Object

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

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

addView, clean, documentClosed, documentClosing, getApplication, getDocumentTemplate, getTitle, getView, getViewCount, isModified, removeView, removeViews, setModified, setTitle

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.event.MessageListener

receiveMessage

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

addPropertyChangeListener, getProperty, removePropertyChangeListener, setProperty

Constructor Detail

IlvWorkspaceDocument

public IlvWorkspaceDocument()

Constructs a new IlvWorkspaceDocument document.

Method Detail

createDataContainer

protected IlvDataContainer createDataContainer(Object userData)

Factory method for creating a data container to associate with this document.
By default, the method creates an instance of IlvWorkspaceDataContainer. It can be overridden to create other data container types.

Overrides:

createDataContainer in class IlvProjectDocument

Parameters:

userData - The user data parameter of the IlvDataContainerDocument.initializeDocument(java.lang.Object) method or null.

Returns:

The newly created IlvWorkspaceDataContainer instance.

initializeDataContainer

protected void initializeDataContainer(IlvDataContainer dataContainer,
                                       Object userData)

Initializes the specified dataContainer.
This method is called when the document is initializing from the initializeDocument method and after the method createDataContainer(java.lang.Object) has been called. By default, it creates a project node that corresponds to this project document. The title of the node is linked to the title of this document. When the title of the document changes, the title of the node has its title updated accordingly.

Overrides:

initializeDataContainer in class IlvProjectDocument

Parameters:

dataContainer - The data container to initialize.

userData - The user data parameter of the IlvDataContainerDocument.initializeDocument(java.lang.Object) method or null.

See Also:

IlvDataContainerDocument.endInitializeDataContainer(ilog.views.appframe.docview.project.IlvDataContainer)