Package org.apache.jmeter.threads.gui

Class AbstractThreadGroupGui

java.lang.Object
java.awt.Component
java.awt.Container
javax.swing.JComponent
javax.swing.JPanel
org.apache.jmeter.gui.AbstractJMeterGuiComponent
org.apache.jmeter.threads.gui.AbstractThreadGroupGui
All Implemented Interfaces:
ImageObserver, MenuContainer, Serializable, Accessible, ClearGui, JMeterGUIComponent, Printable
Direct Known Subclasses:
ThreadGroupGui
public abstract class AbstractThreadGroupGui extends AbstractJMeterGuiComponent
See Also:

  • Constructor Details

    • AbstractThreadGroupGui

      protected AbstractThreadGroupGui()

  • Method Details

    • getMenuCategories

      public Collection<String> getMenuCategories()
      Description copied from interface: JMeterGUIComponent
      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
      See Also:

    • createPopupMenu

      public JPopupMenu createPopupMenu()
      Description copied from interface: JMeterGUIComponent
      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.

    • getPreferredSize

      public Dimension getPreferredSize()
      Overrides:
      getPreferredSize in class JComponent

    • 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

    • assignDefaultValues

      public void assignDefaultValues(org.apache.jmeter.testelement.TestElement element)
      Description copied from interface: JMeterGUIComponent
      Configures default values for element after its creation. Plugin authors should call this once in their JMeterGUIComponent.createTestElement() implementation.
      Parameters:
      element - test element to configure

    • configure

      public void configure(org.apache.jmeter.testelement.TestElement tg)
      Description copied from class: AbstractJMeterGuiComponent
      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:
      tg - the TestElement to configure

    • modifyTestElement

      public void modifyTestElement(org.apache.jmeter.testelement.TestElement element)
      Description copied from interface: JMeterGUIComponent
      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:
      element - the TestElement to modify

    • configureTestElement

      @Deprecated @API(status=DEPRECATED, since="5.6.3") protected void configureTestElement(org.apache.jmeter.testelement.TestElement tg)
      Deprecated.
      Override modifyTestElement(TestElement) instead
      This provides a convenience for extenders when they implement the JMeterGUIComponent.modifyTestElement(TestElement) method. This method will set the name, gui class, and test class for the created Test Element. It should be called by every extending class when creating/modifying Test Elements, as that will best assure consistent behavior.

      Deprecation notice: most likely you do not need the method, and you should override AbstractJMeterGuiComponent.modifyTestElement(TestElement) instead

      Overrides:
      configureTestElement in class AbstractJMeterGuiComponent
      Parameters:
      tg - the TestElement being configured.