Package org.apache.jmeter.control.gui

Class ModuleControllerGui

java.lang.Object
java.awt.Component
java.awt.Container
javax.swing.JComponent
javax.swing.JPanel
org.apache.jmeter.gui.AbstractJMeterGuiComponent
org.apache.jmeter.control.gui.AbstractControllerGui
org.apache.jmeter.control.gui.ModuleControllerGui
All Implemented Interfaces:
ActionListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, ClearGui, JMeterGUIComponent, Printable
public class ModuleControllerGui extends AbstractControllerGui implements ActionListener
ModuleControllerGui provides UI for configuring ModuleController element. It contains filtered copy of test plan tree (called Module to run tree) in which target element can be specified by selecting node. Allowed types of elements in Module to run tree: - TestPlan - cannot be referenced - AbstractThreadGroup - cannot be referenced - Controller (except ModuleController) - TestFragmentController
See Also:

  • Constructor Details

    • ModuleControllerGui

      public ModuleControllerGui()
      Initializes the gui panel for the ModuleController instance.

  • Method Details

    • getLabelResource

      public 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.

      }
      Specified by:
      getLabelResource in interface JMeterGUIComponent
      Returns:
      the resource name

    • configure

      public void configure(org.apache.jmeter.testelement.TestElement el)
      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.}

      Specified by:
      configure in interface JMeterGUIComponent
      Overrides:
      configure in class AbstractJMeterGuiComponent
      Parameters:
      el - the TestElement to configure

    • createTestElement

      public org.apache.jmeter.testelement.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 JMeterGUIComponent.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 JMeterGUIComponent.createTestElement() and override JMeterGUIComponent.makeTestElement() instead. 

       public TestElement createTestElement() {
     TestElementXYZ el = new TestElementXYZ();
     modifyTestElement(el);
     return el;
 }
      }
      Specified by:
      createTestElement in interface JMeterGUIComponent
      Returns:
      the Test Element object that the GUI component represents.

    • modifyTestElement

      public void modifyTestElement(org.apache.jmeter.testelement.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 AbstractJMeterGuiComponent.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 ...
 }
      }
      Specified by:
      modifyTestElement in interface JMeterGUIComponent
      Overrides:
      modifyTestElement in class AbstractJMeterGuiComponent
      Parameters:
      element - the TestElement to modify

    • clearGui

      public 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().}
      Specified by:
      clearGui in interface ClearGui
      Overrides:
      clearGui in class AbstractJMeterGuiComponent

    • createPopupMenu

      public JPopupMenu createPopupMenu()
      When a user right-clicks on the component in the test tree, or selects the edit menu when the component is selected, the component will be asked to return a JPopupMenu that provides all the options available to the user from this component.

      This implementation returns menu items appropriate for most controller components.}

      Specified by:
      createPopupMenu in interface JMeterGUIComponent
      Overrides:
      createPopupMenu in class AbstractControllerGui
      Returns:
      a JPopupMenu appropriate for the component.

    • actionPerformed

      public void actionPerformed(ActionEvent e)
      Implementation of Expand button:
      moves focus to a test plan tree element referenced by selected element in Module to run tree
      Specified by:
      actionPerformed in interface ActionListener

    • expandToSelectNode

      protected void expandToSelectNode(JMeterTreeNode selected)
      Parameters:
      selected - JMeterTreeNode tree node to expand