org.gvsig.app.extension

Class ProjectExtension

java.lang.Object

org.gvsig.andami.plugins.Extension

org.gvsig.app.extension.ProjectExtension

All Implemented Interfaces:

IExtension, IExtensionExecuteWithArgs, IExtensionQueryByAction, IExtensionStatus

public class ProjectExtension
extends Extension
implements IExtensionStatus

Extension que proporciona controles para crear proyectos nuevos, abrirlos y guardarlos. Además los tipos de tabla que soporta el proyecto son añadidos en esta clase.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ProjectExtension.UnsavedProject Implements the IUnsavedData interface to show unsaved projects in the Unsavad Data dialog.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROJECT_FILE_CHOOSER_ID
static String	PROJECTENCODING Deprecated. see PersistentManager

Constructor Summary

Constructors

Constructor and Description
ProjectExtension()

Method Summary

Methods

Modifier and Type	Method and Description
void	addListener(AfterSavingListener l) Adds the specified after saving listener to receive "after saving file events" from this component.
void	addListener(BeforeSavingListener l) Adds the specified before saving listener to receive "before saving file events" from this component.
void	execute(String command) This method is executed when the user clicks on any of the controls associated with this extension (menus, tools, etc).
void	execute(String actionCommand, Object[] args)
protected void	fireAfterSavingFileEvent(SaveEvent evt) Reports a after saving file event.
protected void	fireBeforeSavingFileEvent(SaveEvent evt) Reports a before saving file event.
AfterSavingListener[]	getAfterSavingListeners() Returns an array of all the after saving listeners registered on this component.
BeforeSavingListener[]	getBeforeSavingListeners() Returns an array of all the before saving listeners registered on this component.
static String	getPath()
Project	getProject() Devuelve el proyecto.
ProjectWindow	getProjectFrame()
IWindow	getProjectWindow()
IMonitorableTask[]	getRunningProcesses() Gets an array of the traceable background tasks associated with this extension.
IExtensionStatus	getStatus() Gets the status of the extension, which may be queried to check if the extension has some unsaved data or some associated background tasks.
IUnsavedData[]	getUnsavedData() Gets an array of the UnsavedData objects, which contain information about the unsaved data and allows to save it.
boolean	hasRunningProcesses() This method is used to check if the extension has some associated background process which is currently running.
boolean	hasUnsavedData() This method is used to check if the extension has some unsaved data.
void	initialize() Extension's initialization code should be here.
boolean	isEnabled() This method is invoked by Andami to check whether the extension (and its associated controls) is enabled or disabled.
boolean	isVisible() This method is invoked by Andami to check whether the extension (and its associated controls) is visible or hidden.
void	postInitialize() Extension's post-initialization code should be here.
Project	readProject(File file) Lee del XML el proyecto.
Project	readProject(String path)
void	removeListener(AfterSavingListener l) Removes the specified after saving listener so that it no longer receives save file events from this component.
void	removeListener(BeforeSavingListener l) Removes the specified before saving listener so that it no longer receives save file events from this component.
static void	setPath(String path)
void	setProject(Project p) Sets the project
void	showProjectWindow() Muestra la ventana con el gestor de proyectos.
void	showProjectWindow(WindowInfo wi) Muestra la ventana con el gestor de proyectos, con las propiedades de ventana especificadas.
boolean	writeProject(File file, Project p) Escribe el proyecto en XML.
boolean	writeProject(File file, Project p, boolean askConfirmation) Escribe el proyecto en XML.

Methods inherited from class org.gvsig.andami.plugins.Extension

canQueryByAction, getPlugin, getStatus, getText, isEnabled, isVisible, setPlugin, terminate

Methods inherited from class java.lang.Object

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

Field Detail

PROJECT_FILE_CHOOSER_ID

public static final String PROJECT_FILE_CHOOSER_ID

See Also:

Constant Field Values

PROJECTENCODING

public static String PROJECTENCODING

Deprecated. see PersistentManager

Use UTF-8 for encoding, as it can represent characters from any language. Another sensible option would be encoding = System.getProperty("file.encoding"); but this would need some extra testing.

Constructor Detail

ProjectExtension

public ProjectExtension()

Method Detail

initialize

public void initialize()

Description copied from interface: IExtension

Extension's initialization code should be here. This method is called for all the extensions during Andami's initialization.

Specified by:

initialize in interface IExtension

getProjectFrame

public ProjectWindow getProjectFrame()

showProjectWindow

public void showProjectWindow()

Muestra la ventana con el gestor de proyectos.

showProjectWindow

public void showProjectWindow(WindowInfo wi)

Muestra la ventana con el gestor de proyectos, con las propiedades de ventana especificadas.

execute

public void execute(String command)

Description copied from interface: IExtension

This method is executed when the user clicks on any of the controls associated with this extension (menus, tools, etc).

Specified by:

execute in interface IExtension

Parameters:

command - An String specifying the action to execute. This is useful when there are different controls associated with the same extension.

execute

public void execute(String actionCommand,
           Object[] args)

Specified by:

execute in interface IExtensionExecuteWithArgs

Overrides:

execute in class Extension

postInitialize

public void postInitialize()

Description copied from interface: IExtension

Extension's post-initialization code should be here. This method is called for all the extensions during Andami's initialization, after initialize() has been called for ALL the extensions.

Specified by:

postInitialize in interface IExtension

Overrides:

postInitialize in class Extension

See Also:

com.iver.mdiApp.plugins.IExtension#postInitialize()

writeProject

public boolean writeProject(File file,
                   Project p)

Escribe el proyecto en XML.

Parameters:

file - Fichero.

p - Proyecto.

writeProject

public boolean writeProject(File file,
                   Project p,
                   boolean askConfirmation)

Escribe el proyecto en XML. Pero permite decidir si se pide confirmación para sobreescribir

Parameters:

file - Fichero.

p - Proyecto.

askConfirmation - boolean

readProject

public Project readProject(String path)

readProject

public Project readProject(File file)

Lee del XML el proyecto.

Reads the XML of the project.
It returns a project object holding all needed info that is not linked to the Project Dialog.
In case you want the project to be linked to the window you must set this object to the extension:
Example:
...
...
Project p = ProjectExtension.readProject(projectFile);
ProjectExtension.setProject(p); ...
...

Parameters:

file - Fichero.

Returns:

Project

getProject

public Project getProject()

Devuelve el proyecto.

Returns:

Proyecto.

isEnabled

public boolean isEnabled()

Description copied from interface: IExtension

This method is invoked by Andami to check whether the extension (and its associated controls) is enabled or disabled. Disabled controls (menus and buttons) are shown in light grey colour, and it is not possible to click on them.

Specified by:

isEnabled in interface IExtension

Returns:

true if the extension should be enabled, false otherwise

See Also:

IExtension.isEnabled()

isVisible

public boolean isVisible()

Description copied from interface: IExtension

This method is invoked by Andami to check whether the extension (and its associated controls) is visible or hidden.

Specified by:

isVisible in interface IExtension

Returns:

true if the extension should be visible, false otherwise

See Also:

IExtension.isVisible()

setProject

public void setProject(Project p)

Sets the project

Parameters:

p -

getPath

public static String getPath()

setPath

public static void setPath(String path)

getProjectWindow

public IWindow getProjectWindow()

getStatus

public IExtensionStatus getStatus()

Description copied from interface: IExtension

Gets the status of the extension, which may be queried to check if the extension has some unsaved data or some associated background tasks.

Specified by:

getStatus in interface IExtension

Overrides:

getStatus in class Extension

Returns:

An IExtensionStatus object, containing the status of this extension.

See Also:

IExtensionStatus

hasUnsavedData

public boolean hasUnsavedData()

Description copied from interface: IExtensionStatus

This method is used to check if the extension has some unsaved data. For example, if the project has been modified, or there is a layer in edition mode.

Specified by:

hasUnsavedData in interface IExtensionStatus

Returns:

true if the extension has some unsaved data, false otherwise.

getUnsavedData

public IUnsavedData[] getUnsavedData()

Description copied from interface: IExtensionStatus

Gets an array of the UnsavedData objects, which contain information about the unsaved data and allows to save it.

Specified by:

getUnsavedData in interface IExtensionStatus

Returns:

An array of the associated unsaved data, or null in case the extension has not unsaved data.

getRunningProcesses

public IMonitorableTask[] getRunningProcesses()

Description copied from interface: IExtensionStatus

Gets an array of the traceable background tasks associated with this extension. These tasks may be tracked, canceled, etc.

Specified by:

getRunningProcesses in interface IExtensionStatus

Returns:

An array of the associated background tasks, or null in case there is no associated background tasks.

hasRunningProcesses

public boolean hasRunningProcesses()

Description copied from interface: IExtensionStatus

This method is used to check if the extension has some associated background process which is currently running.

Specified by:

hasRunningProcesses in interface IExtensionStatus

Returns:

true if the extension has some associated background process, false otherwise.

addListener

public void addListener(BeforeSavingListener l)

Adds the specified before saving listener to receive "before saving file events" from this component. If l is null, no exception is thrown and no action is performed.

Parameters:

l - the before saving listener.

See Also:

SaveEvent, BeforeSavingListener, removeListener(BeforeSavingListener), getBeforeSavingListeners()

addListener

public void addListener(AfterSavingListener l)

Adds the specified after saving listener to receive "after saving file events" from this component. If l is null, no exception is thrown and no action is performed.

Parameters:

l - the after saving listener.

See Also:

SaveEvent, AfterSavingListener, removeListener(AfterSavingListener), getAfterSavingListeners()

getBeforeSavingListeners

public BeforeSavingListener[] getBeforeSavingListeners()

Returns an array of all the before saving listeners registered on this component.

Returns:

all of this component's BeforeSavingListeners or an empty array if no key listeners are currently registered

See Also:

#addBeforeSavingListener(BeforeSavingListener), #removeBeforeSavingListener(BeforeSavingListener)

getAfterSavingListeners

public AfterSavingListener[] getAfterSavingListeners()

Returns an array of all the after saving listeners registered on this component.

Returns:

all of this component's AfterSavingListeners or an empty array if no key listeners are currently registered

See Also:

#addAfterSavingListener(AfterSavingListener), #removeAfterSavingListener

removeListener

public void removeListener(BeforeSavingListener l)

Removes the specified before saving listener so that it no longer receives save file events from this component. This method performs no function, nor does it throw an exception, if the listener specified by the argument was not previously added to this component. If listener l is null, no exception is thrown and no action is performed.

Parameters:

l - the before saving listener

See Also:

SaveEvent, BeforeSavingListener, addListener(BeforeSavingListener), getBeforeSavingListeners()

removeListener

public void removeListener(AfterSavingListener l)

Removes the specified after saving listener so that it no longer receives save file events from this component. This method performs no function, nor does it throw an exception, if the listener specified by the argument was not previously added to this component. If listener l is null, no exception is thrown and no action is performed.

Parameters:

l - the after saving listener

See Also:

SaveEvent, AfterSavingListener, addListener(AfterSavingListener), getAfterSavingListeners()

fireBeforeSavingFileEvent

protected void fireBeforeSavingFileEvent(SaveEvent evt)

Reports a before saving file event.

Parameters:

evt - the before saving file event

fireAfterSavingFileEvent

protected void fireAfterSavingFileEvent(SaveEvent evt)

Reports a after saving file event.

Parameters:

evt - the after saving file event