org.gvsig.app.project.documents

Interface DocumentAction

All Superinterfaces:

ExtensionSingleton

All Known Implementing Classes:

AbstractDocumentAction, CopyDocumentAction, CutDocumentAction, GeneratePackageOfPortableViewAction, OpenRelatedPortableViewAction, OpenSourceViewAction, PasteDocumentAction, PortableViewToViewAction, RegeneratePortableViewFromViewAction, ViewToPortableViewAction

public interface DocumentAction
extends ExtensionSingleton

Interface que deben den cumplir las acciones asociadas a un documento
Las acciones de un documento se registraran a traves del metodo registerDocumentAction del ProjectFactory

Por lo general extender de la clase AbstractDocumentAction

Method Summary

Modifier and Type	Method and Description
void	execute(Document document, java.util.List<Document> documents)
java.lang.String	getDescription() Returns a paragraph with the action description for this document type.
DocumentActionGroup	getGroup() Gets the group name for this action.
java.lang.String	getId() Gets the unique identifier for this action.
int	getOrder() Representa el orden en el que se presentara la accion entre elresto de acciones de este tipo documento alla donde estas se presenten.
java.lang.String	getTitle() Returns a phrase with the action title for this document.type.
boolean	isAvailable(Document document, java.util.List<Document> documents)
boolean	isVisible(Document document, java.util.List<Document> documents)

Method Detail

getId

java.lang.String getId()

Gets the unique identifier for this action.

Returns:

id as String

isVisible

boolean isVisible(Document document,
                  java.util.List<Document> documents)

isAvailable

boolean isAvailable(Document document,
                    java.util.List<Document> documents)

execute

void execute(Document document,
             java.util.List<Document> documents)

Parameters:

document - Optionally a document with a special role or null if there is not a document with a special role

documents - Documents to manage

getGroup

DocumentActionGroup getGroup()

Gets the group name for this action.

Returns:

group name as String

getOrder

int getOrder()

Representa el orden en el que se presentara la accion entre elresto de acciones de este tipo documento alla donde estas se presenten.

Returns:

title as String

getTitle

java.lang.String getTitle()

Returns a phrase with the action title for this document.type.

Returns:

description as String

getDescription

java.lang.String getDescription()

Returns a paragraph with the action description for this document type.

Returns:

description as String