Constructor Detail

Method Detail

• setName

   void setName(String name)

  Provides a default implementation for setting the name property. It's unlikely developers will need to override.

• setComment

   void setComment(String comment)

  Provides a default implementation for setting the comment property. It's unlikely developers will need to override.

  Parameters:

  comment - The comment for the property

• isEnabled

   boolean isEnabled()

  Provides a default implementation for the enabled property. It's unlikely developers will need to override.

• getName

   String getName()

  Provides a default implementation for the name property. It's unlikely developers will need to override.

• getComment

   String getComment()

  Provides a default implementation for the comment property. It's unlikely developers will need to override.

  Returns:

  The comment for the property

• configure

   void configure(TestElement element)

  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.

  Parameters:

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

• modifyTestElement

  @API(status = EXPERIMENTAL, since = "5.6.3") 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

• getStaticLabel

   String getStaticLabel()

  Get the component's label. This label is used in drop down lists that give the user the option of choosing one type of component in a list of many. It should therefore be a descriptive name for the end user to see. It must be unique to the class. It is also used by Help to find the appropriate location in the documentation. Normally getLabelResource() should be overridden instead of this method; the definition of this method in AbstractJMeterGuiComponent is intended for general use.

  Returns:

  GUI label for the component.

• getDocAnchor

   String getDocAnchor()

  Compute Anchor value to find reference in documentation for a particular component

  Returns:

  String anchor

• getPrintableComponent

   JComponent getPrintableComponent()

  Subclasses need to over-ride this method, if they wish to return something other than the Visualizer itself.

  Returns:

  this object

• setEnabled

   void setEnabled(boolean enabled)

  Provides a default implementation for the enabled property. It's unlikely developers will need to override.