org.apache.jmeter.gui
Class NamePanel
JPanel
org.apache.jmeter.gui.NamePanel
- JMeterGUIComponent
public class NamePanel
extends JPanel
NamePanel() - Create a new NamePanel with the default name.
|
void | clearGui() - Clear the gui and return it to initial default values.
|
void | configure(TestElement testElement) - 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() - Get the currently displayed name.
|
protected TreeNode | getNode() - Get the tree node which this component provides the name for.
|
String | getStaticLabel() - Get the component's label.
|
void | modifyTestElement(TestElement wb) - GUI components are responsible for populating TestElements they create
with the data currently held in the GUI components.
|
void | setName(String name) - Set the name displayed in this component.
|
void | setNode(TreeNode node) - Set the tree node which this component provides the name for.
|
NamePanel
public NamePanel()
Create a new NamePanel with the default name.
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.
- clearGui in interface JMeterGUIComponent
configure
public void configure(TestElement testElement)
The GUI must be able to extract the data from the TestElement and update
all GUI fields to represent those data. This method is called to allow
JMeter to show the user the GUI that represents the test element's data.
- configure in interface JMeterGUIComponent
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.
- createPopupMenu in interface JMeterGUIComponent
- 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.
- createTestElement in interface JMeterGUIComponent
- the Test Element object that the GUI component represents.
getDocAnchor
public String getDocAnchor()
Get the component's document anchor name. Used by Help to find the
appropriate location in the documentation
- getDocAnchor in interface JMeterGUIComponent
- Document anchor (#ref) for the component.
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.
- getLabelResource in interface JMeterGUIComponent
getMenuCategories
public Collection getMenuCategories()
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.
- getMenuCategories in interface JMeterGUIComponent
- a Collection of Strings, where each element is one of the
constants defined in MenuFactory
getNode
protected TreeNode getNode()
Get the tree node which this component provides the name for.
- the tree node corresponding to this component
getStaticLabel
public String getStaticLabel()
Get the component's label. This label is used in drop down lists that
give the user the option of choosing one type of component in a list of
many. It should therefore be a descriptive name for the end user to see.
It must be unique to the class.
It is also used by Help to find the appropriate location in the
documentation.
Normally getLabelResource() should be overridden instead of
this method; the definition of this method in AbstractJMeterGuiComponent
is intended for general use.
- getStaticLabel in interface JMeterGUIComponent
- GUI label for the component.
modifyTestElement
public void modifyTestElement(TestElement wb)
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.
- modifyTestElement in interface JMeterGUIComponent
setName
public void setName(String name)
Set the name displayed in this component.
- setName in interface JMeterGUIComponent
name
- the name to display
setNode
public void setNode(TreeNode node)
Set the tree node which this component provides the name for.
- setNode in interface JMeterGUIComponent
node
- the tree node corresponding to this component
Copyright © 1998-2010 Apache Software Foundation. All Rights Reserved.