org.apache.jmeter.control.gui

Class TestPlanGui

Implemented Interfaces:
JMeterGUIComponent, Printable

public class TestPlanGui
extends AbstractJMeterGuiComponent

JMeter GUI component representing the test plan which will be executed when the test is run.

Field Summary

Fields inherited from class org.apache.jmeter.gui.AbstractJMeterGuiComponent

namePanel

Constructor Summary

TestPlanGui()
Create a new TestPlanGui.

Method Summary

void
clearGui()
Clear the gui and return it to initial default values.
void
configure(TestElement el)
A newly created component can be initialized with the contents of a Test Element object by calling this method.
protected Container
createClassPathPanel()
JPopupMenu
createPopupMenu()
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.
TestElement
createTestElement()
JMeter test components are separated into a model and a GUI representation.
String
getLabelResource()
Get the component's resource name, which getStaticLabel uses to derive the component's label in the local language.
Collection
getMenuCategories()
This is the list of menu categories this gui component will be available under.
void
modifyTestElement(TestElement plan)
GUI components are responsible for populating TestElements they create with the data currently held in the GUI components.

Methods inherited from class org.apache.jmeter.gui.AbstractJMeterGuiComponent

clearGui, configure, configureTestElement, createTitleLabel, getComment, getDocAnchor, getName, getNamePanel, getNode, getPrintableComponent, getStaticLabel, isEnabled, makeBorder, makeScrollPane, makeScrollPane, makeTitlePanel, setComment, setEnabled, setName, setNode

Constructor Details

TestPlanGui

public TestPlanGui()
Create a new TestPlanGui.

Method Details

clearGui

public void clearGui()
Clear the gui and return it to initial default values. This is necessary because most gui classes are instantiated just once and re-used for multiple test element objects and thus they need to be cleared between use.
Specified by:
clearGui in interface JMeterGUIComponent
Overrides:
clearGui in interface AbstractJMeterGuiComponent

configure

public void configure(TestElement el)
A newly created 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.
Specified by:
configure in interface JMeterGUIComponent
Overrides:
configure in interface AbstractJMeterGuiComponent
Parameters:
el - the TestElement to configure

createClassPathPanel

protected Container createClassPathPanel()

createPopupMenu

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

The TestPlan will return a popup menu allowing you to add ThreadGroups, Listeners, Configuration Elements, Assertions, PreProcessors, PostProcessors, and Timers.

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

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.
Specified by:
createTestElement in interface JMeterGUIComponent
Returns:
the Test Element object that the GUI component represents.

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.
Specified by:
getLabelResource in interface JMeterGUIComponent
Returns:
the resource name

getMenuCategories

public Collection getMenuCategories()
This is the list of menu categories this gui component will be available under. This implementation returns null, since the TestPlan appears at the top level of the tree and cannot be added elsewhere.
Specified by:
getMenuCategories in interface JMeterGUIComponent
Returns:
a Collection of Strings, where each element is one of the constants defined in MenuFactory

modifyTestElement

public void modifyTestElement(TestElement plan)
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.
Specified by:
modifyTestElement in interface JMeterGUIComponent
Parameters:

Copyright © 1998-2010 Apache Software Foundation. All Rights Reserved.