org.apache.jmeter.gui
Class AbstractJMeterGuiComponent
java.lang.Object
|
+--java.awt.Component
|
+--java.awt.Container
|
+--javax.swing.JComponent
|
+--javax.swing.JPanel
|
+--org.apache.jmeter.gui.AbstractJMeterGuiComponent
- All Implemented Interfaces:
- Accessible, ImageObserver, JMeterGUIComponent, MenuContainer, Serializable
- Direct Known Subclasses:
- AbstractAssertionGui, AbstractConfigGui, AbstractControllerGui, AbstractPostProcessorGui, AbstractPreProcessorGui, AbstractSamplerGui, AbstractTimerGui, AbstractVisualizer, ProxyControlGui, TestPlanGui, ThreadGroupGui, WorkBenchGui
- public abstract class AbstractJMeterGuiComponent
- extends JPanel
- implements JMeterGUIComponent
This abstract class takes care of the most basic functions necessary to
create a viable JMeter GUI component. It extends JPanel and implements
JMeterGUIComponent. This abstract class is, in turn, extended by several
other abstract classes that create different classes of GUI components for
JMeter (Visualizers, Timers, Samplers, Modifiers, Controllers, etc).
- Version:
- $Revision: 1.24 $
- Author:
- mstover
- See Also:
JMeterGUIComponent
,
AbstractConfigGui
,
AbstractAssertionGui
,
AbstractControllerGui
,
AbstractTimerGui
,
AbstractVisualizer
,
AbstractSamplerGui
,
Serialized Form
Constructor Summary |
AbstractJMeterGuiComponent()
When constructing a new component, this takes care of basic tasks like
setting up the Name Panel and assigning the class's static label as
the name to start. |
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 |
AbstractJMeterGuiComponent
public AbstractJMeterGuiComponent()
- When constructing a new component, this takes care of basic tasks like
setting up the Name Panel and assigning the class's static label as
the name to start.
setName
public void setName(String name)
- Provides a default implementation for the name property. It's unlikely
developers will need to override.
- Specified by:
setName
in interface JMeterGUIComponent
- Overrides:
setName
in class Component
- Parameters:
name
- the name of the component
isEnabled
public boolean isEnabled()
- Provides a default implementation for the enabled property. It's
unlikely developers will need to override.
- Specified by:
isEnabled
in interface JMeterGUIComponent
- Overrides:
isEnabled
in class Component
- Returns:
- true if the element should be part of the test run, false
otherwise
setEnabled
public void setEnabled(boolean e)
- Provides a default implementation for the enabled property. It's
unlikely developers will need to override.
- Specified by:
setEnabled
in interface JMeterGUIComponent
- Overrides:
setEnabled
in class JComponent
getName
public String getName()
- Provides a default implementation for the name property. It's unlikely
developers will need to override.
- Specified by:
getName
in interface JMeterGUIComponent
- Overrides:
getName
in class Component
- Returns:
- the name of the component
getNamePanel
protected NamePanel getNamePanel()
- Provides the Name Panel for extending classes. Extending classes are
free to place it as desired within the component, or not at all. Most
components place the NamePanel automatically by calling
makeTitlePanel()
instead of directly calling this method.
- Returns:
- a NamePanel containing the name of this component
createTitleLabel
protected Component createTitleLabel()
- Provides a label containing the title for the component. Subclasses
typically place this label at the top of their GUI. The title is set
to the name returned from the component's
getStaticLabel()
method.
Most components place this label automatically by calling
makeTitlePanel()
instead of directly calling this method.
- Returns:
- a JLabel which subclasses can add to their GUI
configure
public 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.
- Specified by:
configure
in interface JMeterGUIComponent
- Parameters:
element
- the TestElement to configure
clear
public void clear()
- Provides a default implementat that resets the name field to the value
of getStaticLabel(), 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.clear().
- Specified by:
clear
in interface JMeterGUIComponent
configureTestElement
protected void configureTestElement(TestElement mc)
- This provides a convenience for extenders when they implement the
JMeterGUIComponent.modifyTestElement(TestElement)
method. This
method will set the name, gui class, and test class for the created Test
Element. It should be called by every extending class when
creating/modifying Test Elements, as that will best assure consistent
behavior.
- Parameters:
mc
- the TestElement being created.
setNode
public void setNode(JMeterTreeNode node)
- Provides a default implementation for the node property. It is unlikely
developers would need to override this method.
- Specified by:
setNode
in interface JMeterGUIComponent
getNode
protected JMeterTreeNode getNode()
- Provides a default implementation for the node property. It is unlikely
developers would need to override this method.
makeTitlePanel
protected Container makeTitlePanel()
- Create a standard title section for JMeter components. This includes
the title for the component and the Name Panel allowing the user to
change the name for the component. This method is typically added to
the top of the component at the beginning of the component's init method.
- Returns:
- a panel containing the component title and name panel
makeBorder
protected Border makeBorder()
- Create a top-level Border which can be added to JMeter components.
Components typically set this as their border in their init method. It
simply provides a nice spacing between the GUI components used and the
edges of the window in which they appear.
- Returns:
- a Border for JMeter components
makeScrollPane
protected JScrollPane makeScrollPane(Component comp)
- Create a scroll panel that sets it's preferred size to it's minimum
size. Explicitly for scroll panes that live inside other scroll panes,
or within containers that stretch components to fill the area they exist
in. Use this for any component you would put in a scroll pane (such as
TextAreas, tables, JLists, etc). It is here for convenience and to
avoid duplicate code. JMeter displays best if you follow this custom.
- Parameters:
comp
- the component which should be placed inside the scroll pane
- Returns:
- a JScrollPane containing the specified component
makeScrollPane
protected JScrollPane makeScrollPane(Component comp,
int verticalPolicy,
int horizontalPolicy)
- Create a scroll panel that sets it's preferred size to it's minimum
size. Explicitly for scroll panes that live inside other scroll panes,
or within containers that stretch components to fill the area they exist
in. Use this for any component you would put in a scroll pane (such as
TextAreas, tables, JLists, etc). It is here for convenience and to
avoid duplicate code. JMeter displays best if you follow this custom.
- Parameters:
comp
- the component which should be placed inside the scroll paneverticalPolicy
- the vertical scroll policyhorizontalPolicy
- the horizontal scroll policy
- Returns:
- a JScrollPane containing the specified component
- See Also:
ScrollPaneConstants
Copyright © 1998-2003 Apache Software Foundation. All Rights Reserved.