root / branches / v2_0_0_prep / applications / appgvSIG / src / org / gvsig / app / project / documents / DocumentAction.java @ 38608
History | View | Annotate | Download (1.45 KB)
1 | 31496 | jjdelcerro | package org.gvsig.app.project.documents; |
---|---|---|---|
2 | |||
3 | import java.util.List; |
||
4 | |||
5 | import org.gvsig.tools.extensionpoint.ExtensionSingleton; |
||
6 | |||
7 | |||
8 | /**
|
||
9 | * Interface que deben den cumplir las acciones asociadas
|
||
10 | * a un documento
|
||
11 | * <br>
|
||
12 | * Las acciones de un documento se registraran a traves
|
||
13 | * del metodo registerDocumentAction del ProjectFactory
|
||
14 | * <br><br>
|
||
15 | * Por lo general extender de la clase AbstractDocumentAction
|
||
16 | *
|
||
17 | *
|
||
18 | *
|
||
19 | */
|
||
20 | |||
21 | public interface DocumentAction extends ExtensionSingleton { |
||
22 | |||
23 | /**
|
||
24 | * Gets the unique identifier for this action.
|
||
25 | *
|
||
26 | * @return id as String
|
||
27 | */
|
||
28 | public String getId(); |
||
29 | |||
30 | public boolean isVisible(Document document, List<Document> documents); |
||
31 | |||
32 | public boolean isAvailable(Document document, List<Document> documents); |
||
33 | |||
34 | public void execute(Document document, List<Document> documents); |
||
35 | |||
36 | /**
|
||
37 | * Gets the group name for this action.
|
||
38 | *
|
||
39 | * @return group name as String
|
||
40 | */
|
||
41 | public DocumentActionGroup getGroup();
|
||
42 | |||
43 | /**
|
||
44 | * Representa el orden en el que se presentara la accion entre
|
||
45 | * elresto de acciones de este tipo documento alla donde estas se
|
||
46 | * presenten.
|
||
47 | *
|
||
48 | * @return title as String
|
||
49 | */
|
||
50 | public int getOrder(); |
||
51 | |||
52 | /**
|
||
53 | * Returns a phrase with the action title for this document.type.
|
||
54 | *
|
||
55 | * @return description as String
|
||
56 | */
|
||
57 | public String getTitle(); |
||
58 | |||
59 | /**
|
||
60 | * Returns a paragraph with the action description for this document
|
||
61 | * type.
|
||
62 | *
|
||
63 | * @return description as String
|
||
64 | */
|
||
65 | public String getDescription(); |
||
66 | |||
67 | } |