org.gvsig.app.project.documents

Interface DocumentManager

All Superinterfaces:

ExtensionBuilder, Observable, PersistenceFactory, WeakReferencingObservable

All Known Subinterfaces:

LayoutManager

All Known Implementing Classes:

AbstractDocumentManager, ChartDocumentManager, DefaultLayoutManager, MapSheetsProjectMapFactory, PortableViewDocumentManager, TableManager, ViewManager

public interface DocumentManager
extends ExtensionBuilder, PersistenceFactory, WeakReferencingObservable

Field Summary

Fields

Modifier and Type	Field and Description
static String	NOTIFY_AFTER_CREATEDOCUMENT
static String	NOTIFY_AFTER_GETMAINWINDOW
static String	NOTIFY_AFTER_GETPROPERTIESWINDOW

Method Summary

Modifier and Type	Method and Description
AbstractDocument	createDocument() Create a new ProjectDocument.
AbstractDocument	createDocumentByUser() Deprecated. user createDocumentsByUser() instead
Iterator<? extends Document>	createDocumentsByUser() Uses a gui to be able from the characteristics that we want a ProjectDocument
boolean	existName(Project project, String documentName) Deprecated. use instead project.getDocument
ImageIcon	getIcon() Returns tdocumenthe icon for the type of document.
ImageIcon	getIconSelected() Returns the icon for the type of document when is selected
JComponent	getMainComponent(Document doc) Devuelbe el JComponent que se corresponde con el documento indicado.
JComponent	getMainComponent(DocumentsContainer container, Document doc) Create a new JComponent for the document or if already exists in the specified container, return this.
IWindow	getMainWindow(Document doc) Return the main window asociated to the passed document.
IWindow	getMainWindow(Document doc, WindowLayout layout) Return the main window asociated to the document.
Class<? extends IDocumentWindow>	getMainWindowClass() Return the class that implement the main window for this type of documents.
int	getPriority() Returns the type of document priority.
IWindow	getPropertiesWindow(Document doc) Return the windows properties asociated to the document.
String	getTitle() Returns the title of type of document.
String	getTypeName() Returns the type name of the document factory.
void	registerMainComponent(DocumentsContainer container, Document document, JComponent component)
void	unregisterMainComponent(DocumentsContainer container, Document document)

Methods inherited from interface org.gvsig.tools.extensionpoint.ExtensionBuilder

create, create, create

Methods inherited from interface org.gvsig.tools.persistence.PersistenceFactory

createFromState, getDefinition, getDefinitions, getDomainName, getDomainURL, getManagedClass, getManagedClass, getManagedClass, getManagedClasses, getManagedClassName, loadFromState, manages, manages, manages, saveToState

Methods inherited from interface org.gvsig.tools.observer.Observable

addObserver, deleteObserver, deleteObservers

Field Detail

NOTIFY_AFTER_CREATEDOCUMENT

static final String NOTIFY_AFTER_CREATEDOCUMENT

See Also:

Constant Field Values

NOTIFY_AFTER_GETMAINWINDOW

static final String NOTIFY_AFTER_GETMAINWINDOW

See Also:

Constant Field Values

NOTIFY_AFTER_GETPROPERTIESWINDOW

static final String NOTIFY_AFTER_GETPROPERTIESWINDOW

See Also:

Constant Field Values

Method Detail

getPriority

int getPriority()

Returns the type of document priority.

Returns:

Priority.

getIcon

ImageIcon getIcon()

Returns tdocumenthe icon for the type of document.

Returns:

Image.

getIconSelected

ImageIcon getIconSelected()

Returns the icon for the type of document when is selected

Returns:

Image.

createDocument

AbstractDocument createDocument()

Create a new ProjectDocument.

Parameters:

project - Opened project.

Returns:

ProjectDocument.

createDocumentByUser

AbstractDocument createDocumentByUser()

Deprecated. user createDocumentsByUser() instead

Uses a gui to be able from the characteristics that we want a ProjectDocument

Returns:

a new Document

createDocumentsByUser

Iterator<? extends Document> createDocumentsByUser()

Uses a gui to be able from the characteristics that we want a ProjectDocument

Returns:

the created documents

getTitle

String getTitle()

Returns the title of type of document.

Returns:

String title for type of document

getTypeName

String getTypeName()

Returns the type name of the document factory.

Returns:

Name of registration

getMainWindow

IWindow getMainWindow(Document doc)

Return the main window asociated to the passed document. If the window alreade exists return it. If not, a new window is created.

Parameters:

doc -

Returns:

Window asociated to document

getMainWindow

IWindow getMainWindow(Document doc,
                      WindowLayout layout)

Return the main window asociated to the document.

Parameters:

doc, - layout

Returns:

Window asociated to document

getMainComponent

JComponent getMainComponent(DocumentsContainer container,
                            Document doc)

Create a new JComponent for the document or if already exists in the specified container, return this.

Parameters:

container -

doc -

Returns:

getMainComponent

JComponent getMainComponent(Document doc)

Devuelbe el JComponent que se corresponde con el documento indicado. Si la ventana activa se corresponde con este documento, devuelbe el JComponent asociado a esa ventana. Si no se corresponde con la ventana activa, pero esta es un contenedor de documentos le pide a este el componente asociado al documento requerido y si lo encuentra lo devuelve. En otro caso develbe null.

Parameters:

doc -

Returns:

el JComponent asociado a doc

unregisterMainComponent

void unregisterMainComponent(DocumentsContainer container,
                             Document document)

registerMainComponent

void registerMainComponent(DocumentsContainer container,
                           Document document,
                           JComponent component)

getPropertiesWindow

IWindow getPropertiesWindow(Document doc)

Return the windows properties asociated to the document.

Parameters:

doc -

Returns:

existName

boolean existName(Project project,
                  String documentName)

Deprecated. use instead project.getDocument

Return true if the name exists to another document.

Parameters:

project -

documentName -

Returns:

True if the name exists.

getMainWindowClass

Class<? extends IDocumentWindow> getMainWindowClass()

Return the class that implement the main window for this type of documents.

Returns:

the class of main window