Package org.apache.jmeter.control.gui

Class TestPlanGui

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.TestPlanGui
All Implemented Interfaces:
ImageObserver, MenuContainer, Serializable, Accessible, ClearGui, JMeterGUIComponent, Printable
public class TestPlanGui extends AbstractJMeterGuiComponent
JMeter GUI component representing the test plan which will be executed when the test is run.
See Also:

  • Constructor Details

    • TestPlanGui

      public TestPlanGui()
      Create a new TestPlanGui.

  • Method Details

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

      The TestPlan will return a popup menu allowing you to add ThreadGroups, Listeners, Configuration Elements, Assertions, PreProcessors, PostProcessors, and Timers.

      Returns:
      a JPopupMenu appropriate for the component.

    • makeTestElement

      public org.apache.jmeter.testelement.TestElement makeTestElement()
      Description copied from interface: JMeterGUIComponent
      Creates the test element represented by the GUI component.
      Returns:
      a new TestElement

    • assignDefaultValues

      public void assignDefaultValues(org.apache.jmeter.testelement.TestElement element)
      Description copied from interface: JMeterGUIComponent
      Configures default values for element after its creation. Plugin authors should call this once in their JMeterGUIComponent.createTestElement() implementation.
      Parameters:
      element - test element to configure

    • modifyTestElement

      public void modifyTestElement(org.apache.jmeter.testelement.TestElement plan)
      Description copied from interface: JMeterGUIComponent
      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:
      plan - the TestElement to modify

    • getLabelResource

      public String getLabelResource()
      Description copied from interface: JMeterGUIComponent
      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

    • getMenuCategories

      public Collection<String> getMenuCategories()
      This is the list of menu categories this gui component will be available under. This implementation returns null, since the TestPlan appears at the top level of the tree and cannot be added elsewhere.
      Returns:
      a Collection of Strings, where each element is one of the constants defined in MenuFactory
      See Also:

    • configure

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

    • clearGui

      public void clearGui()
      Description copied from class: AbstractJMeterGuiComponent
      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