org.gvsig.app.project.documents

Class AbstractDocument

java.lang.Object

org.gvsig.tools.dispose.impl.AbstractDisposable

org.gvsig.app.project.documents.AbstractDocument

All Implemented Interfaces:

java.io.Serializable, Document, Disposable, Persistent, Contains, PropertiesSupport

Direct Known Subclasses:

BaseViewDocument, DefaultLayoutDocument, PortableViewDocument, TableDocument

public abstract class AbstractDocument
extends AbstractDisposable
implements java.io.Serializable, Persistent, Document

Clase base de los elementos del proyecto (mapas, tablas y vistas)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.beans.PropertyChangeSupport	change
static java.lang.String	PERSISTENCE_DEFINITION_NAME

Fields inherited from interface org.gvsig.app.project.documents.Document

ACCESS_DOCUMENT_AUTHORIZATION

Constructor Summary

Constructors

Constructor and Description
AbstractDocument() Creates a new ProjectElement object.
AbstractDocument(DocumentManager factory)

Method Summary

Modifier and Type	Method and Description
void	addListener(ProjectDocumentListener listener) Register a ProjectDocumentListener.
void	addPropertyChangeListener(java.beans.PropertyChangeListener listener) Add a listener to monitor the changes in the properties of the document
void	afterAdd()
void	afterRemove()
protected void	callCreateWindow(IWindow window) Deprecated. use {link raiseEventCreateWindow(IWindow)
boolean	contains(java.lang.Object value)
protected void	doDispose() Internal implementation for the AbstractDisposable.dispose() method, to be implemented by child classes.
java.lang.String	exportDocumentAsText()
java.lang.String	getComment() Gets the comments asociateds to the document
java.lang.String	getCreationDate() Get the creation date of the document.
DocumentManager	getFactory()
javax.swing.JComponent	getMainComponent() Return the main JComponent associated to this document.
IWindow	getMainWindow() Return the main window associated to this document.
java.lang.String	getName() return the name of the document
boolean	getOpenWhenTheUserCreates()
java.lang.String	getOwner() Get the creator name of the document.
Project	getProject()
java.util.Map<java.lang.String,java.lang.Object>	getProperties()
IWindow	getPropertiesWindow()
java.lang.Object	getProperty(java.lang.String name)
java.lang.String	getTypeName() Return the name of the type of documents
WindowLayout	getWindowLayout()
boolean	isAvailable()
boolean	isLocked() Tells whether if this project's element is locked/protected or not.
boolean	isModified()
boolean	isTemporary()
void	loadFromState(PersistentState state) Set the state of the object from the state passed as parameter.
void	lock() Locks this project element protecting it from deleting from the project.
void	raiseEventCreateWindow(IWindow window) Throw this event when a new window is created
void	refresh()
static void	registerPersistent()
void	saveToState(PersistentState state) Saves the internal state of the object on the provided PersistentState object.
void	setComment(java.lang.String string) Gets the comments asociateds to the document
void	setCreationDate(java.lang.String string) Set the creation date of the document.
void	setModified(boolean modified)
void	setName(java.lang.String name) Sets the nane of the document
void	setOwner(java.lang.String string) Sets the creator name of the document
void	setProject(Project project)
void	setProperty(java.lang.String name, java.lang.Object value)
void	setStateFromText(java.lang.String text)
void	setWindowLayout(WindowLayout layout)
java.lang.String	toString()
void	unlock() Unlocks this element.

Methods inherited from class org.gvsig.tools.dispose.impl.AbstractDisposable

dispose, dispose

Methods inherited from class java.lang.Object

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

Field Detail

PERSISTENCE_DEFINITION_NAME

public static final java.lang.String PERSISTENCE_DEFINITION_NAME

See Also:

Constant Field Values

change

protected java.beans.PropertyChangeSupport change

Constructor Detail

AbstractDocument

public AbstractDocument()

Creates a new ProjectElement object.

AbstractDocument

public AbstractDocument(DocumentManager factory)

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

See Also:

Object.toString()

getName

public java.lang.String getName()

return the name of the document

Specified by:

getName in interface Document

Returns:

name as String

getTypeName

public java.lang.String getTypeName()

Return the name of the type of documents

Specified by:

getTypeName in interface Document

Returns:

name as String

setName

public void setName(java.lang.String name)

Sets the nane of the document

Specified by:

setName in interface Document

Parameters:

name - as string

getCreationDate

public java.lang.String getCreationDate()

Get the creation date of the document.

Specified by:

getCreationDate in interface Document

Returns:

creation date as String

getOwner

public java.lang.String getOwner()

Get the creator name of the document.

Specified by:

getOwner in interface Document

Returns:

creator name as String

setCreationDate

public void setCreationDate(java.lang.String string)

Set the creation date of the document.

Specified by:

setCreationDate in interface Document

Parameters:

string -

setOwner

public void setOwner(java.lang.String string)

Sets the creator name of the document

Specified by:

setOwner in interface Document

Parameters:

string -

getComment

public java.lang.String getComment()

Gets the comments asociateds to the document

Specified by:

getComment in interface Document

Returns:

comments as String

setComment

public void setComment(java.lang.String string)

Gets the comments asociateds to the document

Specified by:

setComment in interface Document

Parameters:

string -

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)

Add a listener to monitor the changes in the properties of the document

Specified by:

addPropertyChangeListener in interface Document

Parameters:

listener -

addListener

public void addListener(ProjectDocumentListener listener)

Register a ProjectDocumentListener.

Specified by:

addListener in interface Document

Parameters:

listener - ProjectDocumentListener

getWindowLayout

public WindowLayout getWindowLayout()

Specified by:

getWindowLayout in interface Document

setWindowLayout

public void setWindowLayout(WindowLayout layout)

Specified by:

setWindowLayout in interface Document

loadFromState

public void loadFromState(PersistentState state)
                   throws PersistenceException

Description copied from interface: Persistent

Set the state of the object from the state passed as parameter.

Specified by:

loadFromState in interface Persistent

Throws:

PersistenceException

saveToState

public void saveToState(PersistentState state)
                 throws PersistenceException

Description copied from interface: Persistent

Saves the internal state of the object on the provided PersistentState object.

Specified by:

saveToState in interface Persistent

Throws:

PersistenceException

registerPersistent

public static void registerPersistent()

getProject

public Project getProject()

Specified by:

getProject in interface Document

setProject

public void setProject(Project project)

Specified by:

setProject in interface Document

lock

public void lock()

Locks this project element protecting it from deleting from the project.

Specified by:

lock in interface Document

unlock

public void unlock()

Unlocks this element. So, from now on, it can be removed from the project.

Specified by:

unlock in interface Document

isLocked

public boolean isLocked()

Tells whether if this project's element is locked/protected or not. A protected element cannot be removed from the current project.

Specified by:

isLocked in interface Document

Returns:

true if it is locked, false otherwise

See Also:

lock() and unlock() methods.

getFactory

public DocumentManager getFactory()

Specified by:

getFactory in interface Document

isModified

public boolean isModified()

Specified by:

isModified in interface Document

setModified

public void setModified(boolean modified)

Specified by:

setModified in interface Document

raiseEventCreateWindow

public void raiseEventCreateWindow(IWindow window)

Throw this event when a new window is created

Parameters:

window - IWindow created

callCreateWindow

protected void callCreateWindow(IWindow window)

Deprecated. use {link raiseEventCreateWindow(IWindow)

afterAdd

public void afterAdd()

Specified by:

afterAdd in interface Document

afterRemove

public void afterRemove()

Specified by:

afterRemove in interface Document

exportDocumentAsText

public java.lang.String exportDocumentAsText()

setStateFromText

public void setStateFromText(java.lang.String text)

getPropertiesWindow

public IWindow getPropertiesWindow()

Specified by:

getPropertiesWindow in interface Document

getMainWindow

public IWindow getMainWindow()

Description copied from interface: Document

Return the main window associated to this document. Is a tutility method, is equivalent to: this.getFactory().getMainWindow(doc)

Specified by:

getMainWindow in interface Document

Returns:

the IWindow associated to this document

getMainComponent

public javax.swing.JComponent getMainComponent()

Description copied from interface: Document

Return the main JComponent associated to this document. Is a tutility method, is equivalent to: this.getFactory().getMainComponent(doc)

Specified by:

getMainComponent in interface Document

Returns:

the JComponent associated to this document

isTemporary

public boolean isTemporary()

Specified by:

isTemporary in interface Document

isAvailable

public boolean isAvailable()

Specified by:

isAvailable in interface Document

getOpenWhenTheUserCreates

public boolean getOpenWhenTheUserCreates()

Specified by:

getOpenWhenTheUserCreates in interface Document

contains

public boolean contains(java.lang.Object value)

Specified by:

contains in interface Contains

refresh

public void refresh()

Specified by:

refresh in interface Document

getProperty

public java.lang.Object getProperty(java.lang.String name)

Specified by:

getProperty in interface PropertiesSupport

setProperty

public void setProperty(java.lang.String name,
                        java.lang.Object value)

Specified by:

setProperty in interface PropertiesSupport

getProperties

public java.util.Map<java.lang.String,java.lang.Object> getProperties()

Specified by:

getProperties in interface PropertiesSupport

doDispose

protected void doDispose()
                  throws BaseException

Description copied from class: AbstractDisposable

Internal implementation for the AbstractDisposable.dispose() method, to be implemented by child classes.

Specified by:

doDispose in class AbstractDisposable

Throws:

BaseException

See Also:

AbstractDisposable.dispose()