Class AbstractJMeterGuiComponent

  • All Implemented Interfaces:
    java.awt.MenuContainer , java.awt.image.ImageObserver , java.io.Serializable , javax.accessibility.Accessible , javax.swing.TransferHandler.HasGetTransferHandler , org.apache.jmeter.gui.ClearGui , org.apache.jmeter.gui.JMeterGUIComponent , org.apache.jmeter.visualizers.Printable

    
    public abstract class AbstractJMeterGuiComponent
    extends JPanel implements JMeterGUIComponent, Printable
                        

    This abstract class takes care of the most basic functions necessary to create a viable JMeter GUI component. It extends JPanel and implements JMeterGUIComponent. This abstract class is, in turn, extended by several other abstract classes that create different classes of GUI components for JMeter (Visualizers, Timers, Samplers, Modifiers, Controllers, etc).

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
    • Constructor Summary

      Constructors 
      Constructor Description
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
    • Method Summary

      Modifier and Type Method Description
      void setName(String name) Provides a default implementation for setting the name property.
      void setComment(String comment) Provides a default implementation for setting the comment property.
      boolean isEnabled() Provides a default implementation for the enabled property.
      String getName() Provides a default implementation for the name property.
      String getComment() Provides a default implementation for the comment property.
      void configure(TestElement element) A newly created gui 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 modifyTestElement(TestElement element) GUI components are responsible for populating TestElements they create with the data currently held in the GUI components.
      String getStaticLabel() Get the component's label.
      String getDocAnchor() Compute Anchor value to find reference in documentation for a particular component
      JComponent getPrintableComponent() Subclasses need to over-ride this method, if they wish to return something other than the Visualizer itself.
      void setEnabled(boolean enabled) Provides a default implementation for the enabled property.
      • 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, getName, getParent, getPropertyChangeListeners, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, 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, setName, setSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
      • Methods inherited from class org.apache.jmeter.gui.JMeterGUIComponent

        assignDefaultValues, canBeAdded, createPopupMenu, createTestElement, getLabelResource, getMenuCategories, makeTestElement
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

    • Method Detail

      • setName

         void setName(String name)

        Provides a default implementation for setting the name property. It's unlikely developers will need to override.

      • setComment

         void setComment(String comment)

        Provides a default implementation for setting the comment property. It's unlikely developers will need to override.

        Parameters:
        comment - The comment for the property
      • isEnabled

         boolean isEnabled()

        Provides a default implementation for the enabled property. It's unlikely developers will need to override.

      • getName

         String getName()

        Provides a default implementation for the name property. It's unlikely developers will need to override.

      • getComment

         String getComment()

        Provides a default implementation for the comment property. It's unlikely developers will need to override.

        Returns:

        The comment for the property

      • configure

         void configure(TestElement element)

        A newly created gui 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.

        AbstractJMeterGuiComponent provides a partial implementation of this method, setting the name of the component and its enabled status. Subclasses should override this method, performing their own configuration as needed, but also calling this super-implementation.

        Parameters:
        element - 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().

      • modifyTestElement

        @API(status = EXPERIMENTAL, since = "5.6.3") void modifyTestElement(TestElement element)

        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 ...
        }
        
        Parameters:
        element - the TestElement to modify
      • getStaticLabel

         String getStaticLabel()

        Get the component's label. This label is used in drop down lists that give the user the option of choosing one type of component in a list of many. It should therefore be a descriptive name for the end user to see. It must be unique to the class. It is also used by Help to find the appropriate location in the documentation. Normally getLabelResource() should be overridden instead of this method; the definition of this method in AbstractJMeterGuiComponent is intended for general use.

        Returns:

        GUI label for the component.

      • getDocAnchor

         String getDocAnchor()

        Compute Anchor value to find reference in documentation for a particular component

        Returns:

        String anchor

      • getPrintableComponent

         JComponent getPrintableComponent()

        Subclasses need to over-ride this method, if they wish to return something other than the Visualizer itself.

        Returns:

        this object

      • setEnabled

         void setEnabled(boolean enabled)

        Provides a default implementation for the enabled property. It's unlikely developers will need to override.