Package org.apache.jmeter.control.gui

Class IncludeControllerGui

java.lang.Object
java.awt.Component
java.awt.Container
javax.swing.JComponent
javax.swing.JPanel
org.apache.jmeter.gui.AbstractJMeterGuiComponent
org.apache.jmeter.control.gui.AbstractControllerGui
org.apache.jmeter.control.gui.IncludeControllerGui
All Implemented Interfaces:
ImageObserver, MenuContainer, Serializable, Accessible, ClearGui, JMeterGUIComponent, Printable
public class IncludeControllerGui extends AbstractControllerGui
See Also:

  • Constructor Details

    • IncludeControllerGui

      public IncludeControllerGui()
      Initializes the gui panel for the ModuleController instance.

  • Method Details

    • getLabelResource

      public String getLabelResource()
      Description copied from interface: JMeterGUIComponent
      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.
      Returns:
      the resource name

    • configure

      public void configure(org.apache.jmeter.testelement.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.

      Specified by:
      configure in interface JMeterGUIComponent
      Overrides:
      configure in class AbstractJMeterGuiComponent
      Parameters:
      el - 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.

      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(org.apache.jmeter.testelement.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.

      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:
      element - the TestElement to modify

    • clearGui

      public void clearGui()
      Implements JMeterGUIComponent.clearGui
      Specified by:
      clearGui in interface ClearGui
      Overrides:
      clearGui in class AbstractJMeterGuiComponent

    • createPopupMenu

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

      This implementation returns menu items appropriate for most controller components.

      Specified by:
      createPopupMenu in interface JMeterGUIComponent
      Overrides:
      createPopupMenu in class AbstractControllerGui
      Returns:
      a JPopupMenu appropriate for the component.