Document (Tensegrity API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.tensegrity.gui.document
Interface Document

All Superinterfaces:: Container, Observer

All Known Subinterfaces:: GraphDocument, TemplateDocument

All Known Implementing Classes:: AbstractDocument, SwingGraphDocument, SwingTemplateDocument, SwtGraphDocument

public interface Document
extends Observer, Container

A document is basically a window inside the application containing a single view of user data. In a tabbed mdi-container, the document could be shown on a single tab-pane.

The components that display multiple documents are subclasses of the MDIComponent base class. MDI stands for Multiple-Document-Interface. All these documents are derived from this base interface.

Version:: $Id: Document.java,v 1.20 2006/04/20 08:38:56 BurkhardWick Exp $
Author:: Stepan Rutz

Field Summary
`static int`	`GLUE_LEFTBOTTOM` Some documents can be special, for example a toolbox document, a navigator document and such.
`static int`	`GLUE_LEFTCENTEREXTEND` Some documents can be special, for example a toolbox document, a navigator document and such.
`static int`	`GLUE_LEFTTOP` Some documents can be special, for example a toolbox document, a navigator document and such.
`static int`	`GLUE_RIGHTBOTTOM` Some documents can be special, for example a toolbox document, a navigator document and such.
`static int`	`GLUE_RIGHTCENTEREXTEND` Some documents can be special, for example a toolbox document, a navigator document and such.
`static int`	`GLUE_RIGHTTOP` Some documents can be special, for example a toolbox document, a navigator document and such.
`static int`	`TYPE_FIXED_SIZE` Some documents can be special, for example a toolbox document, a navigator document and such.
`static int`	`TYPE_PACK_IS_OK` Some documents can be special, for example a toolbox document, a navigator document and such.
`static int`	`TYPE_TOOLDOCUMENT` Some documents can be special, for example a toolbox document, a navigator document and such.

Method Summary
`void`	`closeHandler()` This method is a callback that is invoked before the document is closed.
`int`	`getCopyCounter()` Returns the copy counter and increments it by one afterwards.
`DocumentDataProvider`	`getDocumentDataProvider(java.lang.String key)` Returns the `DocumentDataProvider` that can provide the requested information described by the given key.
`java.lang.Object`	`getDocumentSetting(java.lang.String key)` Retrieves the value of an application defined document setting that has been previously stored in this instance.
`AttributeList`	`getDocumentSettings()` Returns all document settings serialized as AttributeList.
`java.io.File`	`getFile()` Gets the file of this document if it was saved or loaded before.
`int`	`getFlags()` Returns flags describing the nature of the document.
`boolean`	`isModified()` Returns a boolean flag which indicates if the document has been modified since the last save operation.
`void`	`setDocumentSetting(java.lang.String key, java.lang.Object value)` Stores the value for an application defined document setting.
`void`	`setDocumentSettings(AttributeList settings)` Sets document settings from an `AttributeList` structure that has usually been read from a file.
`void`	`setFile(java.io.File file)` Sets the file for this document instance.
`void`	`setModified()` Sets the modified flag to true.
`void`	`setUnmodified()` Sets the modified flag to false.

Methods inherited from interface com.tensegrity.generic.util.Observer

update

Methods inherited from interface com.tensegrity.gui.container.Container

getApplicationFrame, getName, setName, setSelected

Field Detail