Class TestBeanGUI
- All Implemented Interfaces:
ImageObserver
,MenuContainer
,Serializable
,Accessible
,ClearGui
,JMeterGUIComponent
,LocaleChangeListener
,Printable
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:
-
Nested Class Summary
Nested classes/interfaces inherited from class javax.swing.JPanel
JPanel.AccessibleJPanel
Nested classes/interfaces inherited from class javax.swing.JComponent
JComponent.AccessibleJComponent
Nested classes/interfaces inherited from class java.awt.Container
Container.AccessibleAWTContainer
Nested classes/interfaces inherited from class java.awt.Component
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy
-
Field Summary
Fields inherited from class org.apache.jmeter.gui.AbstractJMeterGuiComponent
bindingGroup, namePanel
Fields inherited from class javax.swing.JComponent
listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
Fields inherited from class java.awt.Component
accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
-
Constructor Summary
ConstructorDescriptionDeprecated.Dummy for JUnit test purposes onlyTestBeanGUI
(Class<?> testBeanClass) -
Method Summary
Modifier and TypeMethodDescriptionvoid
clearGui()
Provides a default implementation that resets the name field to the value of getStaticLabel(), reset comment and sets enabled to true.void
configure
(org.apache.jmeter.testelement.TestElement element) A newly created gui component can be initialized with the contents of a Test Element object by calling this method.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
JMeter test components are separated into a model and a GUI representation.Compute Anchor value to find reference in documentation for a particular componentGet the component's resource name, which getStaticLabel uses to derive the component's label in the local language.This is the list of add menu categories this gui component will be available under.Get the component's label.boolean
isExpert()
boolean
isHidden()
void
localeChanged
(LocaleChangeEvent event) Handle Locale Change by reloading BeanInfovoid
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.int
Setup GUI classtoString()
Methods inherited from class org.apache.jmeter.gui.AbstractJMeterGuiComponent
configureTestElement, createTitleLabel, getComment, getName, getNamePanel, getPrintableComponent, isEnabled, makeBorder, makeScrollPane, makeScrollPane, makeTitlePanel, setComment, setEnabled, setName, wrapTitlePanel
Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, 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, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, 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, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, 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, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setSize, setSize, show, show, size, transferFocus, transferFocusBackward, transferFocusUpCycle
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.apache.jmeter.gui.JMeterGUIComponent
assignDefaultValues, canBeAdded, getName, isEnabled, makeTestElement, setEnabled, setName
-
Constructor Details
-
TestBeanGUI
Deprecated.Dummy for JUnit test purposes only -
TestBeanGUI
-
-
Method Details
-
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.- Specified by:
getStaticLabel
in interfaceJMeterGUIComponent
- Overrides:
getStaticLabel
in classAbstractJMeterGuiComponent
- Returns:
- GUI label for the component.
- See Also:
-
createTestElement
public org.apache.jmeter.testelement.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.Since 5.6.3, the default implementation is as follows, and subclasses should override
JMeterGUIComponent.makeTestElement()
public TestElement createTestElement() { TestElement element = makeTestElement(); assignDefaultValues(element); return el; }
Before 5.6.3 the canonical implementation was as follows, however, it is recommended to avoid overriding
JMeterGUIComponent.createTestElement()
and overrideJMeterGUIComponent.makeTestElement()
instead.public TestElement createTestElement() { TestElementXYZ el = new TestElementXYZ(); modifyTestElement(el); return el; }
- Specified by:
createTestElement
in interfaceJMeterGUIComponent
- Returns:
- the Test Element object that the GUI component represents.
-
modifyTestElement
public 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. 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.If you override
AbstractJMeterGuiComponent
, you might want usingAbstractJMeterGuiComponent.bindingGroup
instead of overridingmodifyTestElement
.The canonical implementation looks like this:
@Override public void modifyTestElement(TestElement element) { super.modifyTestElement(element); // clear the element and assign basic fields like name, gui class, test class // Using the element setters (preferred): // If the field is empty, you probably want to remove the property instead of storing an empty string // See Streamline binding of UI elements to TestElement properties // for more details TestElementXYZ xyz = (TestElementXYZ) element; xyz.setState(StringUtils.defaultIfEmpty(guiState.getText(), null)); xyz.setCode(StringUtils.defaultIfEmpty(guiCode.getText(), null)); ... other GUI fields ... // or directly (do not use unless there is no setter for the field): element.setProperty(TestElementXYZ.STATE, StringUtils.defaultIfEmpty(guiState.getText(), null)) element.setProperty(TestElementXYZ.CODE, StringUtils.defaultIfEmpty(guiCode.getText(), null)) ... other GUI fields ... }
- Specified by:
modifyTestElement
in interfaceJMeterGUIComponent
- Overrides:
modifyTestElement
in classAbstractJMeterGuiComponent
- Parameters:
element
- the TestElement to modify
-
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.- Specified by:
createPopupMenu
in interfaceJMeterGUIComponent
- Returns:
- a JPopupMenu appropriate for the component.
-
configure
public void configure(org.apache.jmeter.testelement.TestElement element) A newly created gui 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.AbstractJMeterGuiComponent provides a partial implementation of this method, setting the name of the component and its enabled status. Subclasses should override this method, performing their own configuration as needed, but also calling this super-implementation.
- Specified by:
configure
in interfaceJMeterGUIComponent
- Overrides:
configure
in classAbstractJMeterGuiComponent
- Parameters:
element
- the TestElement to configure
-
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.- Specified by:
getMenuCategories
in interfaceJMeterGUIComponent
- Returns:
- a Collection of Strings, where each element is one of the constants defined in MenuFactory
- See Also:
-
setupGuiClasses
public int setupGuiClasses()Setup GUI class- Returns:
- number of matches
-
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 overridden in preference to overriding getStaticLabel(). However where the resource name is not available or required, getStaticLabel() may be overridden instead.
- Specified by:
getLabelResource
in interfaceJMeterGUIComponent
- Returns:
- the resource name
-
clearGui
public void clearGui()Provides a default implementation that resets the name field to the value of getStaticLabel(), reset comment and sets enabled to true. Your GUI may need more things cleared, in which case you should override, clear the extra fields, and still call super.clearGui().- Specified by:
clearGui
in interfaceClearGui
- Overrides:
clearGui
in classAbstractJMeterGuiComponent
-
isHidden
public boolean isHidden() -
isExpert
public boolean isExpert() -
localeChanged
Handle Locale Change by reloading BeanInfo- Specified by:
localeChanged
in interfaceLocaleChangeListener
- Parameters:
event
-LocaleChangeEvent
-
getDocAnchor
Compute Anchor value to find reference in documentation for a particular component}- Specified by:
getDocAnchor
in interfaceJMeterGUIComponent
- Overrides:
getDocAnchor
in classAbstractJMeterGuiComponent
- Returns:
- String anchor
- See Also:
-
toString
-