Constructor Detail

Method Detail

• isStats

   boolean isStats()

  This method is used to indicate a visualizer generates statistics.

  Returns:

  true if visualiser generates statistics

• setFile

   void setFile(String filename)

  Sets the filename which results will be saved to. This will set the filename in the FilePanel. Subclasses don't normally need to call this method, because configuration of the FilePanel is handled in this base class.

  Parameters:

  filename - the new filename

• getFile

   String getFile()

  Gets the filename which has been entered in the FilePanel. Subclasses don't normally need to call this method, because configuration of the FilePanel is handled in this base class.

  Returns:

  the current filename

• stateChanged

   void stateChanged(ChangeEvent e)

  Invoked when the target of the listener has changed its state. This implementation assumes that the target is the FilePanel, and will update the result collector for the new filename.

  Parameters:

  e - the event that has occurred

• 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 c)

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

• configure

   void configure(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.

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