ilog.views.appframe.docview

Class IlvDataDocument

java.lang.Object

ilog.views.appframe.docview.IlvAbstractDocument

ilog.views.appframe.docview.IlvDataDocument

All Implemented Interfaces:

IlvDocument, ActionHandler, MessageListener, IlvPropertyManager, ActionListener, EventListener

public class IlvDataDocument
extends IlvAbstractDocument

Defines documents associated with user data.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DATA_PROPERTY Bound property name for the data associated with the document.

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

REDO_CMD, UNDO_CMD

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
IlvDataDocument() Constructs a new IlvDataDocument instance.
IlvDataDocument(Object data) Constructs a new IlvDataDocument associated with the specified data.

Method Summary

Modifier and Type	Method and Description
Object	getData() Returns the data object associated with this document.
boolean	initializeDocument(Object userData) Initializes a new data document.
void	setData(Object data) Sets a new data object to the document.

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

actionPerformed, activated, 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

Field Detail

DATA_PROPERTY

public static final String DATA_PROPERTY

Bound property name for the data associated with the document.

See Also:

getData(), setData(java.lang.Object), Constant Field Values

Constructor Detail

IlvDataDocument

public IlvDataDocument()

Constructs a new IlvDataDocument instance.

IlvDataDocument

public IlvDataDocument(Object data)

Constructs a new IlvDataDocument associated with the specified data.

Parameters:

data - The user data stored by the document.

See Also:

setData(java.lang.Object)

Method Detail

initializeDocument

public boolean initializeDocument(Object userData)

Initializes a new data document. This method should be overloaded to perform additional initialization work.

Specified by:

initializeDocument in interface IlvDocument

Overrides:

initializeDocument in class IlvAbstractDocument

Parameters:

userData - The user data with which the document is initialized. Its value can be null. This parameter is set to the data document using the method setData(java.lang.Object).

Returns:

true. An overridden method should return true if the document has been successfully initialized; false otherwise.

See Also:

setData(java.lang.Object), IlvApplication.newDocument(java.lang.Object, boolean), IlvApplication.newDocument(), IlvApplication.newDocument(IlvDocumentTemplate, boolean, Object)

getData

public Object getData()

Returns the data object associated with this document.

See Also:

setData(java.lang.Object), DATA_PROPERTY

setData

public void setData(Object data)

Sets a new data object to the document. Fires a property change for the DATA_PROPERTY.

Parameters:

data - The new data object of the document.

See Also:

getData(), DATA_PROPERTY