|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.processmining.framework.util.GUIPropertyListEnumeration
public class GUIPropertyListEnumeration
An enumeration property that can be readily displayed as it maintains its own GUI panel.
The property will be graphically represented as a combo box.
If a description has been provided, it will be displayed as a tool tip.
Changes performed via the GUI will be immedeately propagated to the internally held property value.
Furthermore, a notification target
may be specified
in order to be informed as soon as the value has been changed.
A typical usage scenario looks as follows:
JPanel testPanel = new Panel(); // create parent panel
testPanel.setLayout(new BoxLayout(testPanel, BoxLayout.PAGE_AXIS));
ArrayList
testPanel.add(gender.getPropertyPanel()); // add one property
return testPanel;
Note that this property expects a list of possible values rather than a simple java
enumeration in order also manage the choice between arbitrary objects. Any set of self-defined
objects may be passed to the GUIPropertyListEnumeration as long as these self-defined objects
provide a toString() method in a meaningful way.
getValue
,
getPropertyPanel
Field Summary | |
---|---|
protected javax.swing.JComboBox |
myComboBox
|
protected java.lang.String |
myDescription
|
protected java.lang.String |
myName
|
protected java.util.List |
myPossibleValues
|
protected GuiNotificationTarget |
myTarget
|
protected java.lang.Object |
myValue
|
protected int |
myWidth
|
Constructor Summary | |
---|---|
GUIPropertyListEnumeration(java.lang.String name,
java.util.List values)
Creates an enumeration property without a discription and notification. |
|
GUIPropertyListEnumeration(java.lang.String name,
java.util.List values,
GuiNotificationTarget target)
Creates an enumeration property without a discription. |
|
GUIPropertyListEnumeration(java.lang.String name,
java.lang.String description,
java.util.List values)
Creates an enumeration property without notification. |
|
GUIPropertyListEnumeration(java.lang.String name,
java.lang.String description,
java.util.List values,
GuiNotificationTarget target)
Creates an enumeration property. |
|
GUIPropertyListEnumeration(java.lang.String name,
java.lang.String description,
java.util.List values,
GuiNotificationTarget target,
int width)
Creates an enumeration property. |
Method Summary | |
---|---|
void |
actionPerformed(java.awt.event.ActionEvent e)
The method automatically invoked when changing the combobox status. |
void |
addValue(java.lang.Object value)
Adds an enumeration value. |
void |
disable()
Prevents that this property may be manipulated via the GUI panel. |
void |
enable()
Re-activates the possibility to manipulate this property via the GUI panel. |
java.util.List |
getAllValues()
Retrieves all the possible values specified for this property. |
javax.swing.JPanel |
getPropertyPanel()
Creates GUI panel containg this property, ready to display in some settings dialog. |
java.lang.Object |
getValue()
The method to be invoked when the value of this property is to be used. |
void |
notifyTarget()
Manually notify the target that the state of the radiolist has been changed. |
void |
removeValue(java.lang.Object value)
Removes an enumeration value, if present |
void |
setValue(java.lang.Object value)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected java.lang.String myName
protected java.lang.String myDescription
protected java.util.List myPossibleValues
protected java.lang.Object myValue
protected GuiNotificationTarget myTarget
protected javax.swing.JComboBox myComboBox
protected int myWidth
Constructor Detail |
---|
public GUIPropertyListEnumeration(java.lang.String name, java.util.List values)
name
- the name of this propertyvalues
- the possible values of this property. The objects in this
list should either be simple strings or override the toString() method,
which is then displayed as the name of this value in the ComboBox. The
first value in the list is considered as the default valuepublic GUIPropertyListEnumeration(java.lang.String name, java.lang.String description, java.util.List values)
name
- the name of this propertydescription
- of this property (to be displayed as a tool tip)values
- the possible values of this property. The objects in this
list should either be simple strings or override the toString() method,
which is then displayed as the name of this value in the ComboBox. The
first value in the list is considered as the default valuepublic GUIPropertyListEnumeration(java.lang.String name, java.util.List values, GuiNotificationTarget target)
name
- the name of this propertyvalues
- the possible values of this property. The objects in this
list should either be simple strings or override the toString() method,
which is then displayed as the name of this value in the ComboBox. The
first value in the list is considered as the default valuetarget
- the object to be notified as soon the state of this property changespublic GUIPropertyListEnumeration(java.lang.String name, java.lang.String description, java.util.List values, GuiNotificationTarget target)
name
- the name of this propertydescription
- of this property (to be displayed as a tool tip)values
- the possible values of this property. The objects in this
list should either be simple strings or override the toString() method,
which is then displayed as the name of this value in the ComboBox. The
first value in the list is considered as the default valuetarget
- the object to be notified as soon the state of this property changespublic GUIPropertyListEnumeration(java.lang.String name, java.lang.String description, java.util.List values, GuiNotificationTarget target, int width)
name
- the name of this propertydescription
- of this property (to be displayed as a tool tip)values
- the possible values of this property. The objects in this
list should either be simple strings or override the toString() method,
which is then displayed as the name of this value in the ComboBox. The
first value in the list is considered as the default valuetarget
- the object to be notified as soon the state of this property changeswidth
- a custom width may be specified (default value is 100 otherwise)Method Detail |
---|
public void actionPerformed(java.awt.event.ActionEvent e)
actionPerformed
in interface java.awt.event.ActionListener
e
- the passed action event (not used)public void notifyTarget()
public java.lang.Object getValue()
public void setValue(java.lang.Object value)
public java.util.List getAllValues()
public void removeValue(java.lang.Object value)
value
- Object the enumeration value to be removedpublic void addValue(java.lang.Object value)
value
- Object The enumeration value to be addedpublic void disable()
enable()
public void enable()
disable()
public javax.swing.JPanel getPropertyPanel()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |