Constructor Detail

• ObsoleteGui

  ObsoleteGui()

Method Detail

• 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

• createTestElement

   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 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 createTestElement and override makeTestElement instead.

  public TestElement createTestElement() {
      TestElementXYZ el = new TestElementXYZ();
      modifyTestElement(el);
      return el;
  }
  

  Returns:

  the Test Element object that the GUI component represents.

• modifyTestElement

   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

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

  Returns:

  a JPopupMenu appropriate for the component.

• getMenuCategories

   Collection<String> getMenuCategories()

  This is the list of add menu categories this gui component will be available under. For instance, if this represents a Controller, then the MenuFactory.CONTROLLERS category should be in the returned collection. When a user right-clicks on a tree element and looks through the "add" menu, which category your GUI component shows up in is determined by which categories are returned by this method. Most GUI's belong to only one category, but it is possible for a component to exist in multiple categories.

  Returns:

  a Collection of Strings, where each element is one of the constants defined in MenuFactory