public interface JMeterGUIComponent extends ClearGui
| Modifier and Type | Method and Description |
|---|---|
default boolean |
canBeAdded()
Returns whether a component of this type can be added to the test plan.
|
void |
configure(org.apache.jmeter.testelement.TestElement element)
The GUI must be able to extract the data from the TestElement and update
all GUI fields to represent those data.
|
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.
|
org.apache.jmeter.testelement.TestElement |
createTestElement()
JMeter test components are separated into a model and a GUI
representation.
|
String |
getDocAnchor()
Get the component's document anchor name.
|
String |
getLabelResource()
Get the component's resource name, which getStaticLabel uses to derive
the component's label in the local language.
|
Collection<String> |
getMenuCategories()
This is the list of add menu categories this gui component will be
available under.
|
String |
getName()
Gets the name of the JMeter GUI component.
|
String |
getStaticLabel()
Get the component's label.
|
boolean |
isEnabled()
Test GUI elements can be disabled, in which case they do not become part
of the test when run.
|
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.
|
void |
setEnabled(boolean enabled)
Set whether this component is enabled.
|
void |
setName(String name)
Sets the name of the JMeter GUI Component.
|
void setName(String name)
name - the name of the componentString getName()
String getStaticLabel()
getLabelResource()String getLabelResource()
String getDocAnchor()
org.apache.jmeter.testelement.TestElement createTestElement()
The canonical implementation looks like this:
public TestElement createTestElement() {
TestElementXYZ el = new TestElementXYZ();
modifyTestElement(el);
return el;
}
void modifyTestElement(org.apache.jmeter.testelement.TestElement element)
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 ...
}
element - the TestElement to modifyboolean isEnabled()
void setEnabled(boolean enabled)
enabled - true for enabled, false for disabled.JPopupMenu createPopupMenu()
void configure(org.apache.jmeter.testelement.TestElement element)
The canonical implementation looks like this:
public void configure(TestElement element) {
super.configure(element);
// Using the element getter (preferred):
TestElementXYZ xyz = (TestElementXYZ) element;
guiState.setText(xyz.getState());
guiCode.setText(xyz.getCode());
... other GUI fields ...
// or using the element property names directly (do not use unless there is no getter for the field)
guiState.setText(element.getPropertyAsString(TestElementXYZ.STATE));
guiCode.setText(element.getPropertyAsString(TestElementXYZ.CODE));
... other GUI fields ...
}
element - the TestElement to configureCollection<String> getMenuCategories()
MenuFactorydefault boolean canBeAdded()
Copyright © 1998-2023 Apache Software Foundation. All Rights Reserved.