Package org.apache.jmeter.config.gui

Class ArgumentsPanel

  • All Implemented Interfaces:
    java.awt.MenuContainer , java.awt.event.ActionListener , java.awt.image.ImageObserver , java.io.Serializable , java.util.EventListener , javax.accessibility.Accessible , javax.swing.TransferHandler.HasGetTransferHandler , org.apache.jmeter.gui.ClearGui , org.apache.jmeter.gui.JMeterGUIComponent , org.apache.jmeter.visualizers.Printable 
    
public class ArgumentsPanel
extends AbstractConfigGui implements ActionListener

    A GUI panel allowing the user to enter name-value argument pairs. These arguments (or parameters) are usually used to provide configuration values for some other component.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Constructor Summary

      Constructors 
      Constructor Description
      ArgumentsPanel() Create a new ArgumentsPanel as a standalone component.
      ArgumentsPanel(String label) Create a new ArgumentsPanel as an embedded component, using the specified title.
      ArgumentsPanel(String label, boolean enableUpDown) Create a new ArgumentsPanel as an embedded component, using the specified title.
      ArgumentsPanel(boolean disableButtons, String label) Create a new ArgumentsPanel as an embedded component, using the specified title.
      ArgumentsPanel(String label, Color bkg) Create a new ArgumentsPanel with a border and color background
      ArgumentsPanel(String label, Color bkg, boolean enableUpDown, boolean standalone) Create a new ArgumentsPanel with a border and color background
      ArgumentsPanel(String label, Color bkg, boolean enableUpDown, boolean standalone, ObjectTableModel model) Create a new ArgumentsPanel with a border and color background
      ArgumentsPanel(String label, Color bkg, boolean enableUpDown, boolean standalone, ObjectTableModel model, Function<Array<String>, Argument> argCreator) Create a new ArgumentsPanel with a border and color background
      ArgumentsPanel(String label, Color bkg, boolean enableUpDown, boolean standalone, ObjectTableModel model, boolean disableButtons) Create a new ArgumentsPanel with a border and color background
      ArgumentsPanel(String label, Color bkg, boolean enableUpDown, boolean standalone, ObjectTableModel model, boolean disableButtons, Function<Array<String>, out Argument> argCreator) Create a new ArgumentsPanel with a border and color background

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

      Modifier and Type Method Description
      Collection<String> getMenuCategories() This is the list of menu categories this gui component will be available under.
      String getLabelResource() Get the component's resource name, which getStaticLabel uses to derive the component's label in the local language.
      TestElement createTestElement() JMeter test components are separated into a model and a GUI representation.
      void modifyTestElement(TestElement args) GUI components are responsible for populating TestElements they create with the data currently held in the GUI components.
      void configure(TestElement el) A newly created component can be initialized with the contents of a Test Element object by calling this method.
      void clearGui() Provides a default implementation that resets the name field to the value of getStaticLabel(), reset comment and sets enabled to true.
      void clear() Clear all rows from the table.
      void actionPerformed(ActionEvent e) Invoked when an action occurs.
      static boolean testFunctors()
      void clearBorderForMainPanel() Clear border around "table with arguments".

      • Methods inherited from class org.apache.jmeter.gui.AbstractJMeterGuiComponent

        getComment, getDocAnchor, getName, getPrintableComponent, getStaticLabel, isEnabled, setComment, setEnabled, setName

      • Methods inherited from class javax.swing.JPanel

        getAccessibleContext, getUI, getUIClassID, setUI, updateUI

      • Methods inherited from class javax.swing.JComponent

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

      • Methods inherited from class java.awt.Container

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

      • Methods inherited from class java.awt.Component

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

      • Methods inherited from class org.apache.jmeter.config.gui.AbstractConfigGui

        createPopupMenu

      • Methods inherited from class org.apache.jmeter.gui.JMeterGUIComponent

        assignDefaultValues, canBeAdded, makeTestElement

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • ArgumentsPanel

        ArgumentsPanel()
        Create a new ArgumentsPanel as a standalone component.

      • ArgumentsPanel

        ArgumentsPanel(String label)
        Create a new ArgumentsPanel as an embedded component, using the specified title.
        Parameters:
        label - the title for the component.

      • ArgumentsPanel

        ArgumentsPanel(String label, boolean enableUpDown)
        Create a new ArgumentsPanel as an embedded component, using the specified title.
        Parameters:
        label - the title for the component.
        enableUpDown - Add up/down buttons

      • ArgumentsPanel

        ArgumentsPanel(boolean disableButtons, String label)
        Create a new ArgumentsPanel as an embedded component, using the specified title.
        Parameters:
        disableButtons - Remove Edit all buttons
        label - the title for the component.

      • ArgumentsPanel

        ArgumentsPanel(String label, Color bkg)
        Create a new ArgumentsPanel with a border and color background
        Parameters:
        label - text for label
        bkg - background colour

      • ArgumentsPanel

        ArgumentsPanel(String label, Color bkg, boolean enableUpDown, boolean standalone)
        Create a new ArgumentsPanel with a border and color background
        Parameters:
        label - text for label
        bkg - background colour
        enableUpDown - Add up/down buttons
        standalone - is standalone

      • ArgumentsPanel

        ArgumentsPanel(String label, Color bkg, boolean enableUpDown, boolean standalone, ObjectTableModel model)
        Create a new ArgumentsPanel with a border and color background
        Parameters:
        label - text for label
        bkg - background colour
        enableUpDown - Add up/down buttons
        standalone - is standalone
        model - the table model to use

      • ArgumentsPanel

        ArgumentsPanel(String label, Color bkg, boolean enableUpDown, boolean standalone, ObjectTableModel model, Function<Array<String>, Argument> argCreator)
        Create a new ArgumentsPanel with a border and color background
        Parameters:
        label - text for label
        bkg - background colour
        enableUpDown - Add up/down buttons
        standalone - is standalone
        model - the table model to use
        argCreator - function to create Arguments from Strings taken from clipboard

      • ArgumentsPanel

        ArgumentsPanel(String label, Color bkg, boolean enableUpDown, boolean standalone, ObjectTableModel model, boolean disableButtons)
        Create a new ArgumentsPanel with a border and color background
        Parameters:
        label - text for label
        bkg - background colour
        enableUpDown - Add up/down buttons
        standalone - is standalone
        model - the table model to use
        disableButtons - Remove all buttons

      • ArgumentsPanel

        ArgumentsPanel(String label, Color bkg, boolean enableUpDown, boolean standalone, ObjectTableModel model, boolean disableButtons, Function<Array<String>, out Argument> argCreator)
        Create a new ArgumentsPanel with a border and color background
        Parameters:
        label - text for label
        bkg - background colour
        enableUpDown - Add up/down buttons
        standalone - is standalone
        model - the table model to use
        disableButtons - Remove all buttons
        argCreator - function to create Arguments from Strings taken from clipboard

    • Method Detail

      • getMenuCategories

         Collection<String> getMenuCategories()

        This is the list of menu categories this gui component will be available under.

        Returns:

        a Collection of Strings, where each element is one of the constants defined in MenuFactory

      • getLabelResource

         String getLabelResource()

        Get the component's resource name, which getStaticLabel uses to derive the component's label in the local language. The resource name is fixed, and does not vary with the selected language.

        Normally this method should be overridden in preference to overriding getStaticLabel(). However where the resource name is not available or required, getStaticLabel() may be overridden instead.

        Returns:

        the resource name

      • createTestElement

         TestElement createTestElement()

        JMeter test components are separated into a model and a GUI representation. The model holds the data and the GUI displays it. The GUI class is responsible for knowing how to create and initialize with data the model class that it knows how to display, and this method is called when new test elements are created.

        Since 5.6.3, the default implementation is as follows, and subclasses should override makeTestElement

        public TestElement createTestElement() {
    TestElement element = makeTestElement();
    assignDefaultValues(element);
    return el;
}

        Before 5.6.3 the canonical implementation was as follows, however, it is recommended to avoid overriding createTestElement and override makeTestElement instead. 

        public TestElement createTestElement() {
    TestElementXYZ el = new TestElementXYZ();
    modifyTestElement(el);
    return el;
}
        Returns:

        the Test Element object that the GUI component represents.

      • modifyTestElement

         void modifyTestElement(TestElement args)

        GUI components are responsible for populating TestElements they create with the data currently held in the GUI components. This method should overwrite whatever data is currently in the TestElement as it is called after a user has filled out the form elements in the gui with new information.

        If you override AbstractJMeterGuiComponent, you might want using bindingGroup instead of overriding modifyTestElement.

        The canonical implementation looks like this: 

        @Override
public void modifyTestElement(TestElement element) {
    super.modifyTestElement(element); // clear the element and assign basic fields like name, gui class, test class
    // Using the element setters (preferred):
    // If the field is empty, you probably want to remove the property instead of storing an empty string
    // See Streamline binding of UI elements to TestElement properties
    // for more details
    TestElementXYZ xyz = (TestElementXYZ) element;
    xyz.setState(StringUtils.defaultIfEmpty(guiState.getText(), null));
    xyz.setCode(StringUtils.defaultIfEmpty(guiCode.getText(), null));
    ... other GUI fields ...
    // or directly (do not use unless there is no setter for the field):
    element.setProperty(TestElementXYZ.STATE, StringUtils.defaultIfEmpty(guiState.getText(), null))
    element.setProperty(TestElementXYZ.CODE, StringUtils.defaultIfEmpty(guiCode.getText(), null))
    ... other GUI fields ...
}

      • configure

         void configure(TestElement el)

        A newly created component can be initialized with the contents of a Test Element object by calling this method. The component is responsible for querying the Test Element object for the relevant information to display in its GUI.

        Parameters:
        el - the TestElement to configure

      • clearGui

         void clearGui()

        Provides a default implementation that resets the name field to the value of getStaticLabel(), reset comment and sets enabled to true. Your GUI may need more things cleared, in which case you should override, clear the extra fields, and still call super.clearGui().

      • actionPerformed

         void actionPerformed(ActionEvent e)

        Invoked when an action occurs. This implementation supports the add and delete buttons.

        Parameters:
        e - the event that has occurred

      • clearBorderForMainPanel

         void clearBorderForMainPanel()

        Clear border around "table with arguments". Extra border is not required when the panel is already surrounded by a border.