at.tuwien.ifs.commons.gui.jsap
Class ParameterControl

java.lang.Object
  extended by at.tuwien.ifs.commons.gui.jsap.ParameterControl
Direct Known Subclasses:
FlaggedOptionControl, SwitchControl, UnflaggedOptionControl

public abstract class ParameterControl
extends Object

Version:
$Id: ParameterControl.java 3867 2010-10-21 15:50:10Z mayer $
Author:
Jakob Frank

Field Summary
private static JLabel DEFAULT_EDITOR
           
private  JLabel label
           
private  Color labelFGColor
           
private  com.martiansoftware.jsap.Parameter param
           
private static long serialVersionUID
           
protected static int TOOL_TIP_WIDTH
           
 
Constructor Summary
ParameterControl(com.martiansoftware.jsap.Parameter param)
           
 
Method Summary
(package private) static String createFlagString(char shortFlag, String longFlag)
           
static ParameterControl createParameterControl(com.martiansoftware.jsap.Parameter param, com.martiansoftware.jsap.JSAPResult result)
           
protected static String formatToolTip(String text)
           
abstract  String[] getCommandLine()
           
 JComponent getEditor()
           
 JLabel getLabel()
           
 boolean isRequired()
           
(package private) abstract  boolean isValid()
           
 boolean validate()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

serialVersionUID

private static final long serialVersionUID
See Also:
Constant Field Values

TOOL_TIP_WIDTH

protected static final int TOOL_TIP_WIDTH
See Also:
Constant Field Values

DEFAULT_EDITOR

private static final JLabel DEFAULT_EDITOR

labelFGColor

private Color labelFGColor

label

private JLabel label

param

private final com.martiansoftware.jsap.Parameter param
Constructor Detail

ParameterControl

public ParameterControl(com.martiansoftware.jsap.Parameter param)
Method Detail

getEditor

public JComponent getEditor()
Returns:
The Control of this parameter

getCommandLine

public abstract String[] getCommandLine()
Returns:
The commandline part of this parameter

isRequired

public boolean isRequired()

createParameterControl

public static ParameterControl createParameterControl(com.martiansoftware.jsap.Parameter param,
                                                      com.martiansoftware.jsap.JSAPResult result)
                                               throws SOMToolboxException
Throws:
SOMToolboxException

createFlagString

static String createFlagString(char shortFlag,
                               String longFlag)

validate

public boolean validate()
Returns:
check if the content if the editor is valid.

isValid

abstract boolean isValid()

getLabel

public JLabel getLabel()

formatToolTip

protected static String formatToolTip(String text)