|
Apache JMeter 2.1.1 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Implementing this interface indicates that the class is a JMeter GUI Component. A JMeter GUI Component is essentially the GUI display code associated with a JMeter Test Element. The writer of the component must take care to make the component be consistent with the rest of JMeter's GUI look and feel and behavior. Use of the provided abstract classes is highly recommended to make this task easier.
AbstractJMeterGuiComponent
,
AbstractConfigGui
,
AbstractAssertionGui
,
AbstractControllerGui
,
AbstractTimerGui
,
AbstractVisualizer
,
AbstractSamplerGui
Method Summary | |
void |
clear()
Clear the gui and return it to initial default values. |
void |
configure(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. |
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 |
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(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 |
setNode(JMeterTreeNode node)
Sets the tree node which this component is associated with. |
Method Detail |
public void setName(String name)
name
- the name of the componentpublic String getName()
public String getStaticLabel()
public String getLabelResource()
public String getDocAnchor()
public TestElement createTestElement()
public void modifyTestElement(TestElement element)
element
- the TestElement to modifypublic boolean isEnabled()
public void setEnabled(boolean enabled)
enabled
- true for enabled, false for disabled.public JPopupMenu createPopupMenu()
public void configure(TestElement element)
element
- the TestElement to configurepublic Collection getMenuCategories()
MenuFactory
public void setNode(JMeterTreeNode node)
node
- the tree node corresponding to this componentpublic void clear()
|
Apache JMeter 2.1.1 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |