Package org.apache.jmeter.protocol.java.config.gui

Class JavaConfigGui

java.lang.Object
java.awt.Component
java.awt.Container
javax.swing.JComponent
javax.swing.JPanel
org.apache.jmeter.gui.AbstractJMeterGuiComponent
org.apache.jmeter.config.gui.AbstractConfigGui
org.apache.jmeter.protocol.java.config.gui.JavaConfigGui
All Implemented Interfaces:
ImageObserver, MenuContainer, Serializable, EventListener, Accessible, ChangeListener, ClearGui, JMeterGUIComponent, Printable
public class JavaConfigGui extends AbstractConfigGui implements ChangeListener
The JavaConfigGui class provides the user interface for the JavaConfig object.
See Also:

  • Constructor Details

    • JavaConfigGui

      public JavaConfigGui()
      Create a new JavaConfigGui as a standalone component.

    • JavaConfigGui

      public JavaConfigGui(boolean displayNameField)
      Create a new JavaConfigGui as either a standalone or an embedded component.
      Parameters:
      displayNameField - tells whether the component name should be displayed with the GUI. If true, this is a standalone component. If false, this component is embedded in some other component.

  • Method Details

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

      Specified by:
      getLabelResource in interface JMeterGUIComponent
      Returns:
      the resource name

    • stateChanged

      public void stateChanged(ChangeEvent evt)
      Handle change events for this component. This method currently handles events for the classname JLabeledChoice
      Specified by:
      stateChanged in interface ChangeListener
      Parameters:
      evt - the ActionEvent to be handled

    • configure

      public void configure(org.apache.jmeter.testelement.TestElement config)
      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:
      config - the TestElement to configure

    • createTestElement

      public org.apache.jmeter.testelement.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 JMeterGUIComponent.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 JMeterGUIComponent.createTestElement() and override JMeterGUIComponent.makeTestElement() instead. 

       public TestElement createTestElement() {
     TestElementXYZ el = new TestElementXYZ();
     modifyTestElement(el);
     return el;
 }
      Specified by:
      createTestElement in interface JMeterGUIComponent
      Returns:
      the Test Element object that the GUI component represents.

    • modifyTestElement

      public void modifyTestElement(org.apache.jmeter.testelement.TestElement config)
      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 AbstractJMeterGuiComponent.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 ...
 }
      Specified by:
      modifyTestElement in interface JMeterGUIComponent
      Overrides:
      modifyTestElement in class AbstractJMeterGuiComponent
      Parameters:
      config - the TestElement to modify

    • clearGui

      public void clearGui()
      Description copied from class: AbstractJMeterGuiComponent
      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