view.callassistant

Class ArgumentsPanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

view.callassistant.ArgumentsPanel

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible

public class ArgumentsPanel
extends javax.swing.JPanel

A panel containing a GUI list of argument components contained in a call assistant

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JPanel

javax.swing.JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
static int	ABORT_OPTION
static int	EXECUTE_OPTION
static int	INSERT_OPTION

Fields inherited from class javax.swing.JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
ArgumentsPanel()

Method Summary

Modifier and Type	Method and Description
void	addKeyListener(java.awt.event.KeyListener keyListener)
java.lang.String	argumentsToString() Calls argumentsToString(false,", ","=")
java.lang.String	argumentsToString(boolean includeKeys) calls argumentsToString(includeKeys,", ","=")
java.lang.String	argumentsToString(boolean includeKeys, java.lang.String separator, java.lang.String keyValueSeparator) Creates and returns a user readable string representation of the arguments
int	getArgumentCount() Returns the number of parameters of the call
java.util.Vector<ExecutionReturn>	getEvaluatedArguments() Returns the evaluated arguments in its correct types.
ParameterTuple	getParameterTuple() Returns the parameters of the call
int	getReturnValue() Returns the value indicating which button the user pressed to confirm the input or to abort
java.util.Vector<java.lang.String>	getStringArguments() Returns the evaluated arguments in its string representation.
boolean	hasArguments() Tells whether or not the call has at least one parameter
void	init(ParameterTuple parameterTuple, ArgumentComponentManager argumentComponentManager) Initializes the panel with the given parameters.
void	init(SignatureInterface signature, ArgumentComponentManager argumentComponentManager) Calls init with the parameters of the given signature
boolean	isEvaluationErrorOccured() Tells whether or not, an error occurred during the last evaluation
void	setReturnValue(int returnValue) Sets the value that indicates which button the user pressed to confirm the input or to abort
void	unmarkComponents() Sets the appearance of all argument components to normal state
boolean	updateArguments(UpdateArgumentsMode updateMode) Refreshes the array which holds the evaluated values

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

ABORT_OPTION

public static final int ABORT_OPTION

See Also:

Constant Field Values

INSERT_OPTION

public static final int INSERT_OPTION

See Also:

Constant Field Values

EXECUTE_OPTION

public static final int EXECUTE_OPTION

See Also:

Constant Field Values

Constructor Detail

ArgumentsPanel

public ArgumentsPanel()

Method Detail

init

public void init(ParameterTuple parameterTuple,
                 ArgumentComponentManager argumentComponentManager)

Initializes the panel with the given parameters.

Parameters:

parameterTuple - the parameters according to which the argument components are to be created

argumentComponentManager - the argument component manager to create the argument components

init

public void init(SignatureInterface signature,
                 ArgumentComponentManager argumentComponentManager)

Calls init with the parameters of the given signature

unmarkComponents

public void unmarkComponents()

Sets the appearance of all argument components to normal state

hasArguments

public boolean hasArguments()

Tells whether or not the call has at least one parameter

getReturnValue

public int getReturnValue()

Returns the value indicating which button the user pressed to confirm the input or to abort

setReturnValue

public void setReturnValue(int returnValue)

Sets the value that indicates which button the user pressed to confirm the input or to abort

updateArguments

public boolean updateArguments(UpdateArgumentsMode updateMode)

Refreshes the array which holds the evaluated values

Parameters:

updateMode - specifies, which arrays to update

Returns:

true, if and only if, not error occurred during evaluation

getEvaluatedArguments

public java.util.Vector<ExecutionReturn> getEvaluatedArguments()

Returns the evaluated arguments in its correct types. The values have to be updated before using updateArguments

getStringArguments

public java.util.Vector<java.lang.String> getStringArguments()

Returns the evaluated arguments in its string representation. The string values have to be updated before using updateArguments

getParameterTuple

public ParameterTuple getParameterTuple()

Returns the parameters of the call

isEvaluationErrorOccured

public boolean isEvaluationErrorOccured()

Tells whether or not, an error occurred during the last evaluation

addKeyListener

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

Overrides:

addKeyListener in class java.awt.Component

argumentsToString

public java.lang.String argumentsToString(boolean includeKeys,
                                          java.lang.String separator,
                                          java.lang.String keyValueSeparator)

Creates and returns a user readable string representation of the arguments

Parameters:

includeKeys - if true, also the parameter names will be contained in the string

separator - the separator to separate the parameters of the resulting string

keyValueSeparator - the separator to separate the parameter names from the parameter types. Only effective, if includeKeys is true

Returns:

the created string

argumentsToString

public java.lang.String argumentsToString(boolean includeKeys)

calls argumentsToString(includeKeys,", ","=")

argumentsToString

public java.lang.String argumentsToString()

Calls argumentsToString(false,", ","=")

getArgumentCount

public int getArgumentCount()

Returns the number of parameters of the call