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.

    • createTestElement

      public org.apache.jmeter.testelement.TestElement createTestElement()
      Description copied from interface: JMeterGUIComponent
      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.

      The canonical implementation looks like this: 

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

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

      The canonical implementation looks like this: 

       public void modifyTestElement(TestElement element) {
     element.clear(); // many implementations use this
     configureTestElement(element);
     // Using the element setters (preferred):
     TestElementXYZ xyz = (TestElementXYZ) element;
     xyz.setState(guiState.getText());
     xyz.setCode(guiCode.getText());
     ... other GUI fields ...
     // or directly (do not use unless there is no setter for the field):
     element.setProperty(TestElementXYZ.STATE, guiState.getText())
     element.setProperty(TestElementXYZ.CODE, guiCode.getText())
     ... other GUI fields ...
 }
      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