Class TestBeanGUI
-
- All Implemented Interfaces:
-
java.awt.MenuContainer
,java.awt.image.ImageObserver
,java.io.Serializable
,javax.accessibility.Accessible
,javax.swing.TransferHandler.HasGetTransferHandler
,org.apache.jmeter.gui.ClearGui
,org.apache.jmeter.gui.JMeterGUIComponent
,org.apache.jmeter.util.LocaleChangeListener
,org.apache.jmeter.visualizers.Printable
public class TestBeanGUI extends AbstractJMeterGuiComponent implements JMeterGUIComponent, LocaleChangeListener
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.
-
-
Field Summary
Fields Modifier and Type Field Description private boolean
enabled
public final static String
uiClassID
public float
alignmentX
public float
alignmentY
public boolean
autoscrolls
public Border
border
public InputVerifier
inputVerifier
public boolean
verifyInputWhenFocusTarget
public final static int
WHEN_FOCUSED
public final static int
WHEN_ANCESTOR_OF_FOCUSED_COMPONENT
public final static int
WHEN_IN_FOCUSED_WINDOW
public final static int
UNDEFINED_CONDITION
public final static String
TOOL_TIP_TEXT_KEY
public ActionMap
actionMap
public transient FocusTraversalPolicy
focusTraversalPolicy
public transient Container
parent
public int
x
public int
y
public int
width
public int
height
public Color
foreground
public Color
background
public volatile Font
font
public Cursor
cursor
public Locale
locale
public boolean
ignoreRepaint
public DropTarget
dropTarget
public String
name
public boolean
focusTraversalKeysEnabled
public transient ComponentOrientation
componentOrientation
public final static float
TOP_ALIGNMENT
public final static float
CENTER_ALIGNMENT
public final static float
BOTTOM_ALIGNMENT
public final static float
LEFT_ALIGNMENT
public final static float
RIGHT_ALIGNMENT
public final static int
WIDTH
public final static int
HEIGHT
public final static int
PROPERTIES
public final static int
SOMEBITS
public final static int
FRAMEBITS
public final static int
ALLBITS
public final static int
ERROR
public final static int
ABORT
-
Constructor Summary
Constructors Constructor Description TestBeanGUI()
TestBeanGUI(Class<out Object> testBeanClass)
-
Method Summary
Modifier and Type Method Description String
getStaticLabel()
Get the component's label. TestElement
createTestElement()
JMeter test components are separated into a model and a GUI representation. void
modifyTestElement(TestElement element)
GUI components are responsible for populating TestElements they create with the data currently held in the GUI components. 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. void
configure(TestElement element)
A newly created gui component can be initialized with the contents of a Test Element object by calling this method. Collection<String>
getMenuCategories()
This is the list of add menu categories this gui component will be available under. int
setupGuiClasses()
Setup GUI class String
getLabelResource()
Get the component's resource name, which getStaticLabel uses to derive the component's label in the local language. void
clearGui()
Provides a default implementation that resets the name field to the value of getStaticLabel(), reset comment and sets enabled to true. boolean
isHidden()
boolean
isExpert()
void
localeChanged(LocaleChangeEvent event)
Handle Locale Change by reloading BeanInfo String
getDocAnchor()
Compute Anchor value to find reference in documentation for a particular component } String
toString()
-
Methods inherited from class org.apache.jmeter.gui.AbstractJMeterGuiComponent
getComment, getName, getPrintableComponent, isEnabled, setComment, setEnabled, setName
-
Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUI, getUIClassID, setUI, updateUI
-
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, contains, createToolTip, disable, enable, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputVerifier, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getTopLevelAncestor, getTransferHandler, getUI, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, requestDefaultFocus, requestFocus, requestFocus, 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, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
-
Methods inherited from class java.awt.Container
add, add, addContainerListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, getComponent, getComponentAt, getComponentCount, getComponentZOrder, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, locate, minimumSize, paintComponents, preferredSize, printComponents, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate
-
Methods inherited from class java.awt.Component
action, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, createImage, createVolatileImage, dispatchEvent, enableInputMethods, getBackground, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getParent, getPropertyChangeListeners, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusOwner, isFocusTraversable, isFocusable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, resize, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusTraversalKeysEnabled, setFocusable, setIgnoreRepaint, setLocale, setLocation, setMixingCutoutShape, setSize, show, size, transferFocus, transferFocusBackward, transferFocusUpCycle
-
Methods inherited from class org.apache.jmeter.gui.JMeterGUIComponent
assignDefaultValues, canBeAdded, makeTestElement
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
Method Detail
-
getStaticLabel
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.
-
createTestElement
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 #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 #createTestElement() and override #makeTestElement() instead.
public TestElement createTestElement() { TestElementXYZ el = new TestElementXYZ(); modifyTestElement(el); return el; }
-
modifyTestElement
void modifyTestElement(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 , you might want using AbstractJMeterGuiComponent#bindingGroup instead of overriding modifyTestElement}.
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 ... }
-
createPopupMenu
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.
-
configure
void configure(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.
-
getMenuCategories
Collection<String> 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.
-
setupGuiClasses
int setupGuiClasses()
Setup GUI class
- Returns:
number of matches
-
getLabelResource
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 overridden in preference to overriding getStaticLabel(). However where the resource name is not available or required, getStaticLabel() may be overridden instead.
-
clearGui
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().
-
isHidden
boolean isHidden()
-
isExpert
boolean isExpert()
-
localeChanged
void localeChanged(LocaleChangeEvent event)
Handle Locale Change by reloading BeanInfo
- Parameters:
event
- LocaleChangeEvent
-
getDocAnchor
String getDocAnchor()
Compute Anchor value to find reference in documentation for a particular component }
-
-
-
-