org.ow2.clif.scenario.isac.egui.plugins.gui
Class ParameterPanel

java.lang.Object
  extended by org.eclipse.swt.widgets.Widget
      extended by org.eclipse.swt.widgets.Control
          extended by org.eclipse.swt.widgets.Scrollable
              extended by org.eclipse.swt.widgets.Composite
                  extended by org.ow2.clif.scenario.isac.egui.plugins.gui.ParameterPanel
All Implemented Interfaces:
org.eclipse.swt.graphics.Drawable

public class ParameterPanel
extends org.eclipse.swt.widgets.Composite

Implementation of the panel which will store all the paraemters widgets

Author:
JC Meillaud, A Peyrard

Field Summary
 
Fields inherited from class org.eclipse.swt.widgets.Composite
embeddedHandle
 
Fields inherited from class org.eclipse.swt.widgets.Widget
handle
 
Constructor Summary
ParameterPanel(org.eclipse.swt.widgets.Composite parent)
          Build a new parameter panel
 
Method Summary
 boolean addButtonSelected(java.lang.Object source)
           
 org.eclipse.swt.widgets.Composite addWidget(java.util.Map<java.lang.String,java.lang.Object> params, int style, java.lang.String name, java.lang.String label, org.eclipse.swt.widgets.Composite c, org.eclipse.swt.events.ModifyListener listener)
          Add a new widget to this panel
static void createNewPanelsFromXML(java.util.Vector ids, PluginDescription plugin, java.io.InputStream fileName, java.util.Map<java.lang.String,ParametersWidgetsNode> panels)
          Analyse a gui XML file, this kind of file define all the panels parameters for a plugin
static ParameterPanel createParameterPanel(ParametersWidgetsNode node, org.eclipse.swt.widgets.Composite parent, org.eclipse.swt.events.ModifyListener listener)
          Build a new parameter panel from a parameters widgets tree
 void dispose()
          dispose all the elements of the panel
 java.util.Map getParametersValues()
          Builds a map with all parameters names and parameters values
 boolean modifySomething(java.lang.Object source)
           
 boolean removeButtonSelected(java.lang.Object source)
           
 void setComboValues(java.util.Vector values)
          method wich set the values for the combo which is named "id"
 void setParametersValues(java.util.Map<java.lang.String,java.lang.String> values)
          method which set the values of the differents parameters
 
Methods inherited from class org.eclipse.swt.widgets.Composite
changed, checkSubclass, computeSize, getBackgroundMode, getChildren, getClientArea, getLayout, getLayoutDeferred, getTabList, isLayoutDeferred, layout, layout, layout, layout, setBackgroundMode, setFocus, setLayout, setLayoutDeferred, setTabList
 
Methods inherited from class org.eclipse.swt.widgets.Scrollable
computeTrim, getBorderWidth, getHorizontalBar, getVerticalBar
 
Methods inherited from class org.eclipse.swt.widgets.Control
addControlListener, addDragDetectListener, addFocusListener, addHelpListener, addKeyListener, addMenuDetectListener, addMouseListener, addMouseMoveListener, addMouseTrackListener, addMouseWheelListener, addPaintListener, addTraverseListener, computeSize, dragDetect, dragDetect, forceFocus, getAccessible, getBackground, getBackgroundImage, getBounds, getCursor, getDragDetect, getEnabled, getFont, getForeground, getLayoutData, getLocation, getMenu, getMonitor, getParent, getShell, getSize, getToolTipText, getVisible, internal_dispose_GC, internal_new_GC, isEnabled, isFocusControl, isReparentable, isVisible, moveAbove, moveBelow, pack, pack, redraw, redraw, removeControlListener, removeDragDetectListener, removeFocusListener, removeHelpListener, removeKeyListener, removeMenuDetectListener, removeMouseListener, removeMouseMoveListener, removeMouseTrackListener, removeMouseWheelListener, removePaintListener, removeTraverseListener, setBackground, setBackgroundImage, setBounds, setBounds, setCapture, setCursor, setDragDetect, setEnabled, setFont, setForeground, setLayoutData, setLocation, setLocation, setMenu, setParent, setRedraw, setSize, setSize, setToolTipText, setVisible, toControl, toControl, toDisplay, toDisplay, traverse, update
 
Methods inherited from class org.eclipse.swt.widgets.Widget
addDisposeListener, addListener, checkWidget, getData, getData, getDisplay, getStyle, isDisposed, isListening, notifyListeners, removeDisposeListener, removeListener, removeListener, setData, setData, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ParameterPanel

public ParameterPanel(org.eclipse.swt.widgets.Composite parent)
Build a new parameter panel

Parameters:
parent - The parent composite of this panel
Method Detail

addWidget

public org.eclipse.swt.widgets.Composite addWidget(java.util.Map<java.lang.String,java.lang.Object> params,
                                                   int style,
                                                   java.lang.String name,
                                                   java.lang.String label,
                                                   org.eclipse.swt.widgets.Composite c,
                                                   org.eclipse.swt.events.ModifyListener listener)
Add a new widget to this panel

Parameters:
params - The widgets parameters
style - The style of the widget
name - The name of the parameter which is representing by this widget
label -
c -
listener - The modify listener which will be used for each parameter widgets
Returns:
Composite

getParametersValues

public java.util.Map getParametersValues()
Builds a map with all parameters names and parameters values

Returns:
The map containing the values and names of parameters

createNewPanelsFromXML

public static void createNewPanelsFromXML(java.util.Vector ids,
                                          PluginDescription plugin,
                                          java.io.InputStream fileName,
                                          java.util.Map<java.lang.String,ParametersWidgetsNode> panels)
Analyse a gui XML file, this kind of file define all the panels parameters for a plugin

Parameters:
ids -
plugin - The plugin description
fileName - The fileName to be analysed
panels - The table where the panels must be stored

createParameterPanel

public static ParameterPanel createParameterPanel(ParametersWidgetsNode node,
                                                  org.eclipse.swt.widgets.Composite parent,
                                                  org.eclipse.swt.events.ModifyListener listener)
Build a new parameter panel from a parameters widgets tree

Parameters:
node - The tree
parent - The parent composite
listener - The modify listener which will be used for each parameter widgets
Returns:
The parameter panel created

setComboValues

public void setComboValues(java.util.Vector values)
method wich set the values for the combo which is named "id"

Parameters:
values - The values

setParametersValues

public void setParametersValues(java.util.Map<java.lang.String,java.lang.String> values)
method which set the values of the differents parameters

Parameters:
values - The parameters values

addButtonSelected

public boolean addButtonSelected(java.lang.Object source)
Parameters:
source -
Returns:
boolean

removeButtonSelected

public boolean removeButtonSelected(java.lang.Object source)
Parameters:
source -
Returns:
boolean

modifySomething

public boolean modifySomething(java.lang.Object source)
Parameters:
source -
Returns:
boolean

dispose

public void dispose()
dispose all the elements of the panel

Overrides:
dispose in class org.eclipse.swt.widgets.Widget