Constructor Detail

• ExampleSamplerGui

  public ExampleSamplerGui()

Method Detail

• getLabelResource

  public 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 overriden in preference to overriding getStaticLabel(). However where the resource name is not available or required, getStaticLabel() may be overridden instead.

  Returns:

  the resource name

• configure

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

  Specified by:

  configure in interface JMeterGUIComponent

  Overrides:

  configure in class AbstractJMeterGuiComponent

  Parameters:

  element - the TestElement to configure

• createTestElement

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

  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(TestElement te)

  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:

  te - the TestElement to modify

• clearGui

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

  Specified by:

  clearGui in interface ClearGui

  Overrides:

  clearGui in class AbstractJMeterGuiComponent