Constructor Detail

• TestPlanGui

  TestPlanGui()

  Create a new TestPlanGui.

Method Detail

• createPopupMenu

   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

   TestElement makeTestElement()

  Creates the test element represented by the GUI component.

  Returns:

  a new TestElement

  Since:

  5.6.3

• assignDefaultValues

   void assignDefaultValues(TestElement element)

  Configures default values for element after its creation. Plugin authors should call this once in their createTestElement implementation.

  Parameters:

  element - test element to configure

  Since:

  5.6.3

• modifyTestElement

   void modifyTestElement(TestElement plan)

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

• 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

• getMenuCategories

   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

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