blob: a841c503d005b824dadcd235fce17355d8aa58f6 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
|
/*****************************************************************************
* Copyright (c) 2010 CEA LIST.
*
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* Remi Schnekenburger (CEA LIST) remi.schnekenburger@cea.fr - Initial API and implementation
*****************************************************************************/
package org.eclipse.papyrus.properties.runtime.state;
import java.beans.PropertyChangeListener;
import org.eclipse.papyrus.properties.runtime.view.IConfigurableDescriptor;
import org.eclipse.swt.graphics.Image;
import org.w3c.dom.Document;
import org.w3c.dom.Node;
/**
* Common interface to all states
*/
public interface IState {
/**
* returns the label displayed by this state
*
* @return the label displayed by this state
*/
public String getText();
/**
* returns the image displayed by this state
*
* @return the image displayed by this state
*/
public Image getImage();
/**
* Returns the descriptor managed by this state
*
* @return the descriptor managed by this state
*/
public IConfigurableDescriptor getDescriptor();
/**
* Returns the identifier of the dialog used to edit this element
*
* @return the identifier of the dialog used to edit this element
*/
public String getEditionDialogId();
/**
* Adds a property change listener to this class
*
* @param listener
* the listener to add
*/
public void addPropertyChangeListener(PropertyChangeListener listener);
/**
* Removes a property change listener from this class
*
* @param listener
* the listener to remove
*/
public void removePropertyChangeListener(PropertyChangeListener listener);
/**
* Serializes the state under the form of an xml node
*
* @param document
* the document used to create elements
* @return the generate node
*/
public Node generateNode(Document document);
/**
* Indicates if the state is in read only mode
*
* @return <code>true</code> if the state should be unmodifiable
*/
public boolean isReadOnly();
}
|