Class TestPlanGui
-
- 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.visualizers.Printable
public class TestPlanGui extends AbstractJMeterGuiComponent
JMeter GUI component representing the test plan which will be executed when the test is run.
-
-
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 TestPlanGui()
Create a new TestPlanGui.
-
Method Summary
Modifier and Type Method Description 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
makeTestElement()
Creates the test element represented by the GUI component. void
assignDefaultValues(TestElement element)
Configures default values for element after its creation. void
modifyTestElement(TestElement plan)
GUI components are responsible for populating TestElements they create with the data currently held in the GUI components. String
getLabelResource()
Get the component's resource name, which getStaticLabel uses to derive the component's label in the local language. Collection<String>
getMenuCategories()
This is the list of menu categories this gui component will be available under. void
configure(TestElement el)
A newly created component can be initialized with the contents of a Test Element object by calling this method. void
clearGui()
Provides a default implementation that resets the name field to the value of getStaticLabel(), reset comment and sets enabled to true. -
Methods inherited from class org.apache.jmeter.gui.AbstractJMeterGuiComponent
getComment, getDocAnchor, getName, getPrintableComponent, getStaticLabel, 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, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
-
Methods inherited from class org.apache.jmeter.gui.JMeterGUIComponent
canBeAdded, createTestElement
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
Method Detail
-
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.
The TestPlan will return a popup menu allowing you to add ThreadGroups, Listeners, Configuration Elements, Assertions, PreProcessors, PostProcessors, and Timers.
- Returns:
a JPopupMenu appropriate for the component.
-
makeTestElement
TestElement makeTestElement()
Creates the test element represented by the GUI component.
- Returns:
a new TestElement
- Since:
5.6.3
-
assignDefaultValues
void assignDefaultValues(TestElement element)
Configures default values for element after its creation. Plugin authors should call this once in their createTestElement implementation.
- Parameters:
element
- test element to configure- Since:
5.6.3
-
modifyTestElement
void modifyTestElement(TestElement plan)
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 using 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 ... }
-
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.
- Returns:
the resource name
-
getMenuCategories
Collection<String> getMenuCategories()
This is the list of menu categories this gui component will be available under. This implementation returns null, since the TestPlan appears at the top level of the tree and cannot be added elsewhere.
- Returns:
a Collection of Strings, where each element is one of the constants defined in MenuFactory
-
configure
void configure(TestElement el)
A newly created 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.
- Parameters:
el
- the TestElement to configure
-
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().
-
-
-
-