org.apache.jmeter.testbeans.gui
Class TestBeanGUI
java.lang.Object
java.awt.Component
java.awt.Container
javax.swing.JComponent
javax.swing.JPanel
org.apache.jmeter.gui.AbstractJMeterGuiComponent
org.apache.jmeter.testbeans.gui.TestBeanGUI
- All Implemented Interfaces:
- Accessible, ImageObserver, JMeterGUIComponent, MenuContainer, Printable, Serializable
- public class TestBeanGUI
- extends AbstractJMeterGuiComponent
- implements JMeterGUIComponent
JMeter GUI element editing for TestBean elements.
The actual GUI is always a bean customizer: if the bean descriptor provides
one, it will be used; otherwise, a GenericTestBeanCustomizer will be created
for this purpose.
Those customizers deviate from the standards only in that, instead of a bean,
they will receive a Map in the setObject call. This will be a property name
to value Map. The customizer is also in charge of initializing empty Maps
with sensible initial values.
If the provided Customizer class implements the SharedCustomizer interface,
the same instance of the customizer will be reused for all beans of the type:
setObject(map) can then be called multiple times. Otherwise, one separate
instance will be used for each element. For efficiency reasons, most
customizers should implement SharedCustomizer.
- See Also:
- Serialized Form
Method Summary |
void |
clearGui()
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 |
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 |
getStaticLabel()
Get the component's label. |
void |
modifyTestElement(TestElement element)
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 |
configureTestElement, createTitleLabel, getComment, getDocAnchor, getName, getNamePanel, getNode, getPrintableComponent, isEnabled, makeBorder, makeScrollPane, makeScrollPane, makeTitlePanel, setComment, setEnabled, setName, setNode |
Methods inherited from class javax.swing.JComponent |
addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setFont, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update |
Methods inherited from class java.awt.Container |
add, add, add, add, add, addContainerListener, addImpl, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setLayout, transferFocusBackward, transferFocusDownCycle, validate, validateTree |
Methods inherited from class java.awt.Component |
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle |
TestBeanGUI
public TestBeanGUI()
TestBeanGUI
public TestBeanGUI(Class testBeanClass)
getStaticLabel
public String getStaticLabel()
- Description copied from interface:
JMeterGUIComponent
- 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.
- Specified by:
getStaticLabel
in interface JMeterGUIComponent
- Overrides:
getStaticLabel
in class AbstractJMeterGuiComponent
createTestElement
public TestElement createTestElement()
- Description copied from interface:
JMeterGUIComponent
- 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.
modifyTestElement
public void modifyTestElement(TestElement element)
- Description copied from interface:
JMeterGUIComponent
- 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:
element
- the TestElement to modify
createPopupMenu
public JPopupMenu createPopupMenu()
- Description copied from interface:
JMeterGUIComponent
- 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.
- Specified by:
createPopupMenu
in interface JMeterGUIComponent
- Returns:
- a JPopupMenu appropriate for the component.
configure
public void configure(TestElement element)
- Description copied from interface:
JMeterGUIComponent
- 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.
- Specified by:
configure
in interface JMeterGUIComponent
- Overrides:
configure
in class AbstractJMeterGuiComponent
- Parameters:
element
- the TestElement to configure
getMenuCategories
public Collection getMenuCategories()
- Description copied from interface:
JMeterGUIComponent
- 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.
- Specified by:
getMenuCategories
in interface JMeterGUIComponent
- Returns:
- a Collection of Strings, where each element is one of the
constants defined in MenuFactory
- See Also:
MenuFactory
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 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
clearGui
public void clearGui()
- Description copied from interface:
JMeterGUIComponent
- 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 class AbstractJMeterGuiComponent
Copyright © 1998-2009 Apache Software Foundation. All Rights Reserved.