view.argumentcomponents

Class ArgumentComponentManager

java.lang.Object

view.argumentcomponents.ArgumentComponentManager

public class ArgumentComponentManager
extends java.lang.Object

Stores and manages argument components to easily access and create components depending on the type

Constructor Summary

Constructors

Constructor and Description
ArgumentComponentManager(MainControl mainControl) Creates an instance

Method Summary

Modifier and Type	Method and Description
void	addType(ScriptType argumentType, java.lang.Class<? extends ArgumentComponent> argumentComponentClass) Calls addType with the name of the given type and the given argument component class
void	addType(java.lang.String[] argumentTypeNames, ArgumentComponentFactory argumentComponentFactory) Calls addType for each of the entries of the given array with the given argument component factory
void	addType(java.lang.String[] argumentTypeNames, java.lang.Class<? extends ArgumentComponent> argumentComponentClass) Calls addType with each of the entries of the given array with the given argument component class
void	addType(java.lang.String argumentTypeName, ArgumentComponentFactory argumentComponentFactory) Registers a new argument component factory and associates it with the given Graphana type
void	addType(java.lang.String argumentTypeName, java.lang.Class<? extends ArgumentComponent> argumentComponentClass) Registers the given type key word with the given argument component class.
ArgumentComponent	getArgumentComponent(ScriptType argumentType, java.awt.Container topParent) Creates and returns an argument component its class is associated with the given type
MainControl	getMainControl()
java.lang.String	openAutoCompleteAssistant(SignatureInterface signature, java.awt.Component parentComponent) Opens the call assistant for a call of the operation of the given signature.
ArgumentsPanel	openCallAssistant(Description description, ArgumentsPanelSettings settings, java.lang.String title, ParameterTuple parameters, java.awt.Component parentComponent, UpdateArgumentsMode updateMode) Creates a call assistant according to the given parameters.
java.lang.String	openScriptCallAssistant(ScriptCallSignature scriptCallSignature, java.awt.Component parentComponent) Opens the call assistant for a call of the script of the given script signature.

Methods inherited from class java.lang.Object

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

Constructor Detail

ArgumentComponentManager

public ArgumentComponentManager(MainControl mainControl)

Creates an instance

Parameters:

mainControl - the main control of Graphana

Method Detail

addType

public void addType(java.lang.String argumentTypeName,
                    ArgumentComponentFactory argumentComponentFactory)

Registers a new argument component factory and associates it with the given Graphana type

Parameters:

argumentTypeName - the key of the type to associate with

argumentComponentFactory - the factory to create an argument component whenever a component of the given type is demanded

addType

public void addType(java.lang.String[] argumentTypeNames,
                    ArgumentComponentFactory argumentComponentFactory)

Calls addType for each of the entries of the given array with the given argument component factory

addType

public void addType(java.lang.String argumentTypeName,
                    java.lang.Class<? extends ArgumentComponent> argumentComponentClass)

Registers the given type key word with the given argument component class. Whenever an argument component is demanded with the given key, an instance of the respective argument component will be created and returned.

Parameters:

argumentTypeName - the name of the Graphana type to associate the argument component with

argumentComponentClass - the class of the argument component to register

addType

public void addType(java.lang.String[] argumentTypeNames,
                    java.lang.Class<? extends ArgumentComponent> argumentComponentClass)

Calls addType with each of the entries of the given array with the given argument component class

addType

public void addType(ScriptType argumentType,
                    java.lang.Class<? extends ArgumentComponent> argumentComponentClass)

Calls addType with the name of the given type and the given argument component class

getArgumentComponent

public ArgumentComponent getArgumentComponent(ScriptType argumentType,
                                              java.awt.Container topParent)

Creates and returns an argument component its class is associated with the given type

Parameters:

argumentType - the type of the value

topParent - the parent into which the component is to be added

Returns:

the created argument component or an instance of the default ArgumentExecuted class, if no argument component is associated with the given type

openCallAssistant

public ArgumentsPanel openCallAssistant(Description description,
                                        ArgumentsPanelSettings settings,
                                        java.lang.String title,
                                        ParameterTuple parameters,
                                        java.awt.Component parentComponent,
                                        UpdateArgumentsMode updateMode)

Creates a call assistant according to the given parameters.

Parameters:

description - the description of the operation to call

settings - determines, what the user can do with the created call

title - the title of the call assistant

parameters - the parameters of the call

parentComponent - the component into which the panel is to be added

updateMode - determines, which type of values are needed when fetching the evaluated call

Returns:

the created panel or null, if an error occurred

openAutoCompleteAssistant

public java.lang.String openAutoCompleteAssistant(SignatureInterface signature,
                                                  java.awt.Component parentComponent)

Opens the call assistant for a call of the operation of the given signature. The method is blocking until the user finished the input.

Parameters:

signature - the signature holding the parameters to build the call assistant

parentComponent - the component into which the assistant is to be added

Returns:

the string after it was created using the user inputs

openScriptCallAssistant

public java.lang.String openScriptCallAssistant(ScriptCallSignature scriptCallSignature,
                                                java.awt.Component parentComponent)

Opens the call assistant for a call of the script of the given script signature. The method is blocking until the user finished the input.

Parameters:

scriptCallSignature - the signature of the script to call

parentComponent - the component into which the assistant is to be added

Returns:

the string after it was created using the user inputs

getMainControl

public MainControl getMainControl()