org.gvsig.app.project.documents.view

Class BaseViewDocument

java.lang.Object

org.gvsig.app.project.documents.AbstractDocument

org.gvsig.app.project.documents.view.BaseViewDocument

All Implemented Interfaces:

Serializable, Document, ViewDocument, ErrorListener, ExtendedPropertiesSupport, Persistent

Direct Known Subclasses:

DefaultViewDocument

public abstract class BaseViewDocument
extends AbstractDocument
implements ErrorListener, ViewDocument

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected MapContext	mapContext
protected MapContext	mapOverViewContext
static String	PERSISTENCE_DEFINITION_NAME

Fields inherited from class org.gvsig.app.project.documents.AbstractDocument

change

Fields inherited from interface org.gvsig.app.project.documents.view.ViewDocument

LAYER_PROPERTIES_PAGE_GROUP, VIEW_PROPERTIES_PAGE_GROUP

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

ACCESS_DOCUMENT_AUTHORIZATION

Constructor Summary

Constructors

Constructor and Description
BaseViewDocument()
BaseViewDocument(DocumentManager factory)

Method Summary

Methods

Modifier and Type	Method and Description
void	afterAdd()
void	afterRemove()
void	center(Envelope envelope) Center view in the envelope.
boolean	contains(DataStore store) Return true if this view has a layer with this store.
boolean	contains(FLayer layer) Return true if layer is in this view.
Iterator<FLayer>	deepiterator() Get all layer in the view TOC.
void	errorThrown(ErrorEvent e) Listen for error events (usually caused by driverExceptions)
Map	getExtendedProperties() Returns a hash map with all new properties associated to this layer.
MapContext	getMapContext() Gets the MapContext of the main map in the view.
MapContext	getMapOverViewContext() Gets the MapContext from the locator, which is the small map in the left-bottom corner of the View.
IProjection	getOverViewProjection()
IProjection	getProjection() Gets the CRS of the view
Object	getProperty(Object key) Returns a reference to an object (property) associated to this layer.
boolean	isLocked() Tells whether if this project's element is locked/protected or not.
Iterator<FLayer>	iterator() Get the first level of layer in the view TOC.
void	loadFromState(PersistentState state) Set the state of the object from the state passed as parameter.
void	reportDriverExceptions(String introductoryText, List driverExceptions) Reports to the user a bundle of driver exceptions produced in the same atomic MapContext transaction
void	saveToState(PersistentState state) Saves the internal state of the object on the provided PersistentState object.
void	setBackColor(Color c)
void	setMapContext(MapContext fmap)
void	setMapOverViewContext(MapContext fmap)
void	setName(String name) Sets the nane of the document
void	setProjection(IProjection proj)
void	setProperty(Object key, Object obj) Inserts an object as a property to this layer.
void	showErrors()

Methods inherited from class org.gvsig.app.project.documents.AbstractDocument

addListener, addPropertyChangeListener, callCreateWindow, exportDocumentAsText, getComment, getCreationDate, getFactory, getMainComponent, getMainWindow, getName, getOwner, getProject, getPropertiesWindow, getTypeName, getWindowLayout, isAvailable, isModified, isTemporary, lock, raiseEventCreateWindow, registerPersistent, setComment, setCreationDate, setModified, setOwner, setProject, setStateFromText, setWindowLayout, toString, unlock

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.gvsig.app.project.documents.view.ViewDocument

addPropertyChangeListener, getName, getProject

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

addListener, getComment, getCreationDate, getFactory, getMainComponent, getMainWindow, getOwner, getPropertiesWindow, getTypeName, getWindowLayout, isAvailable, isModified, isTemporary, lock, setComment, setCreationDate, setModified, setOwner, setProject, setWindowLayout, unlock

Field Detail

PERSISTENCE_DEFINITION_NAME

public static final String PERSISTENCE_DEFINITION_NAME

See Also:

Constant Field Values

mapOverViewContext

protected MapContext mapOverViewContext

mapContext

protected MapContext mapContext

Constructor Detail

BaseViewDocument

public BaseViewDocument()

BaseViewDocument

public BaseViewDocument(DocumentManager factory)

Method Detail

getMapContext

public MapContext getMapContext()

Gets the MapContext of the main map in the view.

Specified by:

getMapContext in interface ViewDocument

Returns:

the main MapContext

setName

public void setName(String name)

Description copied from class: AbstractDocument

Sets the nane of the document

Specified by:

setName in interface Document

Overrides:

setName in class AbstractDocument

Parameters:

name - as string

getMapOverViewContext

public MapContext getMapOverViewContext()

Gets the MapContext from the locator, which is the small map in the left-bottom corner of the View.

Specified by:

getMapOverViewContext in interface ViewDocument

Returns:

the locator MapContext

setMapContext

public void setMapContext(MapContext fmap)

Specified by:

setMapContext in interface ViewDocument

setMapOverViewContext

public void setMapOverViewContext(MapContext fmap)

Specified by:

setMapOverViewContext in interface ViewDocument

showErrors

public void showErrors()

reportDriverExceptions

public void reportDriverExceptions(String introductoryText,
                          List driverExceptions)

Reports to the user a bundle of driver exceptions produced in the same atomic MapContext transaction

Specified by:

reportDriverExceptions in interface ErrorListener

Parameters:

introductoryText - introductory text specified by developer. It null, used ""

driverExceptions - list with a bundle of driver exceptions catched during an atomic event

getProjection

public IProjection getProjection()

Description copied from interface: ViewDocument

Gets the CRS of the view

Specified by:

getProjection in interface ViewDocument

Returns:

CRS of the view

setProjection

public void setProjection(IProjection proj)

Specified by:

setProjection in interface ViewDocument

getOverViewProjection

public IProjection getOverViewProjection()

afterRemove

public void afterRemove()

Specified by:

afterRemove in interface Document

Overrides:

afterRemove in class AbstractDocument

afterAdd

public void afterAdd()

Specified by:

afterAdd in interface Document

Overrides:

afterAdd in class AbstractDocument

setBackColor

public void setBackColor(Color c)

Specified by:

setBackColor in interface ViewDocument

errorThrown

public void errorThrown(ErrorEvent e)

Description copied from interface: ErrorListener

Listen for error events (usually caused by driverExceptions)

Specified by:

errorThrown in interface ErrorListener

isLocked

public boolean isLocked()

Description copied from class: AbstractDocument

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

Overrides:

isLocked in class AbstractDocument

Returns:

true if it is locked, false otherwise

See Also:

lock() and unlock() methods.

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

Overrides:

saveToState in class AbstractDocument

Throws:

PersistenceException

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

Overrides:

loadFromState in class AbstractDocument

Throws:

PersistenceException

getProperty

public Object getProperty(Object key)

Description copied from interface: ExtendedPropertiesSupport

Returns a reference to an object (property) associated to this layer.

For example, you can attach a network definition to key "network" and check if a layer has a network loaded using getAssociatedObject("network") and that it's not null.

Specified by:

getProperty in interface ExtendedPropertiesSupport

Parameters:

key - the key associated to the property

Returns:

null if key is not found

See Also:

ExtendedPropertiesSupport.getExtendedProperties(), ExtendedPropertiesSupport.setProperty(Object, Object)

setProperty

public void setProperty(Object key,
               Object obj)

Description copied from interface: ExtendedPropertiesSupport

Inserts an object as a property to this layer.

Specified by:

setProperty in interface ExtendedPropertiesSupport

Parameters:

key - the key associated to the property

obj - the property

See Also:

ExtendedPropertiesSupport.getProperty(Object), ExtendedPropertiesSupport.getExtendedProperties()

getExtendedProperties

public Map getExtendedProperties()

Description copied from interface: ExtendedPropertiesSupport

Returns a hash map with all new properties associated to this layer.

Specified by:

getExtendedProperties in interface ExtendedPropertiesSupport

Returns:

hash table with the added properties

See Also:

ExtendedPropertiesSupport.getProperty(Object), ExtendedPropertiesSupport.setProperty(Object, Object)

iterator

public Iterator<FLayer> iterator()

Description copied from interface: ViewDocument

Get the first level of layer in the view TOC.

Specified by:

iterator in interface ViewDocument

Returns:

layers in TOC

deepiterator

public Iterator<FLayer> deepiterator()

Description copied from interface: ViewDocument

Get all layer in the view TOC.

Specified by:

deepiterator in interface ViewDocument

Returns:

layers in TOC

contains

public boolean contains(FLayer layer)

Description copied from interface: ViewDocument

Return true if layer is in this view.

Specified by:

contains in interface ViewDocument

Returns:

contains

public boolean contains(DataStore store)

Description copied from interface: ViewDocument

Return true if this view has a layer with this store.

Specified by:

contains in interface ViewDocument

Returns:

center

public void center(Envelope envelope)

Description copied from interface: ViewDocument

Center view in the envelope.

Specified by:

center in interface ViewDocument