view.argumentcomponents

Class ArgumentComponent

java.lang.Object

view.argumentcomponents.ArgumentComponent

Direct Known Subclasses:

ArgumentBoolean, ArgumentComplexType, ArgumentComponentComboBox, ArgumentComponentSpinner, ArgumentComponentTextField, ArgumentFile, ArgumentFileFormat, ArgumentFiles

public abstract class ArgumentComponent
extends java.lang.Object

Java GUI component to let the user set a value of a graphana type. One graphana type is meant to be associated with one argument component.

Field Summary

Fields

Modifier and Type	Field and Description
static java.awt.Color	CL_DEFAULT
static java.awt.Color	CL_ERROR
static java.awt.Font	DEFAULT_FONT
static javax.swing.border.Border	DEFAULT_INNER_BORDER
static javax.swing.border.Border	DEFAULT_TEXT_BORDER
protected boolean	markIfError

Constructor Summary

Constructors

Constructor and Description
ArgumentComponent() Creates an instance but does not initialize it.

Method Summary

Modifier and Type	Method and Description
void	addKeyListener(java.awt.event.KeyListener keyListener) Adds the given key listener to this and eventually inner components
protected ExecutionReturn	checkAndExecute(java.lang.String statement, MainControl mainControl) Executes the given statement and returns the result if it is not an error.
void	error(java.lang.String errorMessage) Highlights the component to indicate that the value is invalid.
abstract ExecutionReturn	evaluate() Evaluates the user input and creates a respective graphana value
java.lang.String	evaluateToString() Evalutates the user input and returns it in its string representation
abstract java.awt.Component	getComponent() Returns the topmost component to add it into a GUI
int	getComponentHeight() Returns the height of the component in pixels
int	getComponentMinWidth() Returns the width of the component in pixels
java.awt.Component	getInnerComponent() Returns the inner component of this component or the component itself, if there is no inner component.
protected java.awt.Container	getTopParent() Returns the parent of this component.
protected abstract void	init(MainControl mainControl, ScriptType scriptType, ArgumentComponentManager argumentComponentManager)
void	init(MainControl mainControl, ScriptType scriptType, ArgumentComponentManager argumentComponentManager, java.awt.Container topParent) Initializes and builds the component and sub components
void	resetToolTip() Disables the tooltip
void	setComponentColor(java.awt.Color color) Sets the color of the component and eventually the sub components
void	setMarkIfError(boolean markIfError) If set to true, then the component will be highlighted once it detected an error during evaluation
void	setParameterName(java.lang.String parameterName) Sets a special name of the type.
abstract void	setToolTip(java.lang.String tooltip) Sets the tooltip of the component and eventually of sub components
abstract void	setValue(ExecutionReturn value) Sets the value within the component to the given value
protected ExecutionError	throwError(ExecutionError error) Outputs the given error.
ExecutionErrorMessage	throwError(java.lang.String message) Outputs the given error.
protected java.lang.String	throwStringError(ExecutionError error) Outputs the given error.
protected java.lang.String	throwStringError(java.lang.String errorMessage) Outputs the given error.
void	unmark() Sets the appearance back to normal

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CL_DEFAULT

public static final java.awt.Color CL_DEFAULT

CL_ERROR

public static final java.awt.Color CL_ERROR

DEFAULT_FONT

public static final java.awt.Font DEFAULT_FONT

DEFAULT_INNER_BORDER

public static final javax.swing.border.Border DEFAULT_INNER_BORDER

DEFAULT_TEXT_BORDER

public static final javax.swing.border.Border DEFAULT_TEXT_BORDER

markIfError

protected boolean markIfError

Constructor Detail

ArgumentComponent

public ArgumentComponent()

Creates an instance but does not initialize it.

Method Detail

init

protected abstract void init(MainControl mainControl,
                             ScriptType scriptType,
                             ArgumentComponentManager argumentComponentManager)

getComponent

public abstract java.awt.Component getComponent()

Returns the topmost component to add it into a GUI

setValue

public abstract void setValue(ExecutionReturn value)

Sets the value within the component to the given value

evaluate

public abstract ExecutionReturn evaluate()

Evaluates the user input and creates a respective graphana value

setToolTip

public abstract void setToolTip(java.lang.String tooltip)

Sets the tooltip of the component and eventually of sub components

init

public void init(MainControl mainControl,
                 ScriptType scriptType,
                 ArgumentComponentManager argumentComponentManager,
                 java.awt.Container topParent)

Initializes and builds the component and sub components

Parameters:

mainControl - the main control of Graphana

scriptType - the graphana type

argumentComponentManager - the manager instance which handles all argument components

topParent - the parent within which this component is to be added

getTopParent

protected java.awt.Container getTopParent()

Returns the parent of this component. This component is a direct child of the given parent

setParameterName

public void setParameterName(java.lang.String parameterName)

Sets a special name of the type. This is for example necessary for complex types, where the concrete name depends on the sub type.

setMarkIfError

public void setMarkIfError(boolean markIfError)

If set to true, then the component will be highlighted once it detected an error during evaluation

getComponentHeight

public int getComponentHeight()

Returns the height of the component in pixels

getComponentMinWidth

public int getComponentMinWidth()

Returns the width of the component in pixels

getInnerComponent

public java.awt.Component getInnerComponent()

Returns the inner component of this component or the component itself, if there is no inner component. If there are actually multiple inner components, only the important one will be returned

setComponentColor

public void setComponentColor(java.awt.Color color)

Sets the color of the component and eventually the sub components

error

public void error(java.lang.String errorMessage)

Highlights the component to indicate that the value is invalid.

Parameters:

errorMessage - the message to display (for example as tooltip)

unmark

public void unmark()

Sets the appearance back to normal

addKeyListener

public void addKeyListener(java.awt.event.KeyListener keyListener)

Adds the given key listener to this and eventually inner components

throwError

protected ExecutionError throwError(ExecutionError error)

Outputs the given error. Eventually the component is highlighted

Returns:

the given error

throwError

public ExecutionErrorMessage throwError(java.lang.String message)

Outputs the given error. Eventually the component is highlighted.

Parameters:

message - the error message to output, for example as a tooltip

Returns:

the given error as an ExecutionErrorMessage to further process it within a script

resetToolTip

public void resetToolTip()

Disables the tooltip

throwStringError

protected java.lang.String throwStringError(java.lang.String errorMessage)

Outputs the given error. Eventually the component is highlighted.

Parameters:

errorMessage - the error message to output, for example as a tooltip

Returns:

null

throwStringError

protected java.lang.String throwStringError(ExecutionError error)

Outputs the given error. Eventually the component is highlighted

Parameters:

error - the error to output in its string representation, for example as a tooltip

Returns:

null

evaluateToString

public java.lang.String evaluateToString()

Evalutates the user input and returns it in its string representation

Returns:

the user intput in its string representation or null, if user input could not be evaluated

checkAndExecute

protected ExecutionReturn checkAndExecute(java.lang.String statement,
                                          MainControl mainControl)

Executes the given statement and returns the result if it is not an error. If an error occurs, the component is set to error state.

Parameters:

statement - the statement to execute in Graphana syntax

mainControl - the main control of Graphana

Returns:

the result of the execution or null, if an error occurred during execution