org.apache.jmeter.gui

Class AbstractJMeterGuiComponent

Implemented Interfaces:
JMeterGUIComponent, Printable
Known Direct Subclasses:
AbstractAssertionGui, AbstractConfigGui, AbstractControllerGui, AbstractListenerGui, AbstractPostProcessorGui, AbstractPreProcessorGui, AbstractReportGui, AbstractSamplerGui, AbstractTimerGui, ObsoleteGui, TestBeanGUI, TestPlanGui, ThreadGroupGui, WorkBenchGui

public abstract class AbstractJMeterGuiComponent
extends JPanel
implements JMeterGUIComponent, Printable

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).
See Also:
JMeterGUIComponent, AbstractConfigGui, AbstractAssertionGui, AbstractControllerGui, AbstractTimerGui, AbstractVisualizer, AbstractSamplerGui

Field Summary

protected NamePanel
namePanel
A GUI panel containing the name of this component.

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.

Method Summary

void
clearGui()
Provides a default implementation that resets the name field to the value of getStaticLabel(), reset comment and sets enabled to true.
void
configure(TestElement element)
A newly created gui component can be initialized with the contents of a Test Element object by calling this method.
protected void
configureTestElement(TestElement mc)
This provides a convenience for extenders when they implement the JMeterGUIComponent.modifyTestElement(TestElement) method.
protected Component
createTitleLabel()
Provides a label containing the title for the component.
String
getComment()
Provides a default implementation for the comment property.
String
getDocAnchor()
Get the component's document anchor name.
String
getName()
Provides a default implementation for the name property.
protected NamePanel
getNamePanel()
Provides the Name Panel for extending classes.
protected TreeNode
getNode()
Provides a default implementation for the node property.
JComponent
getPrintableComponent()
Subclasses need to over-ride this method, if they wish to return something other than the Visualizer itself.
String
getStaticLabel()
Get the component's label.
boolean
isEnabled()
Provides a default implementation for the enabled property.
protected Border
makeBorder()
Create a top-level Border which can be added to JMeter components.
protected JScrollPane
makeScrollPane(Component comp)
Create a scroll panel that sets it's preferred size to it's minimum size.
protected JScrollPane
makeScrollPane(Component comp, int verticalPolicy, int horizontalPolicy)
Create a scroll panel that sets it's preferred size to it's minimum size.
protected Container
makeTitlePanel()
Create a standard title section for JMeter components.
void
setComment(String comment)
Provides a default implementation for setting the comment property.
void
setEnabled(boolean e)
Provides a default implementation for the enabled property.
void
setName(String name)
Provides a default implementation for setting the name property.
void
setNode(TreeNode node)
Provides a default implementation for the node property.

Field Details

namePanel

protected NamePanel namePanel
A GUI panel containing the name of this component.

Constructor Details

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.

Method Details

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 interface JMeterGUIComponent

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

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.

createTitleLabel

protected Component createTitleLabel()
Returns:
a JLabel which subclasses can add to their GUI

getComment

public String getComment()
Provides a default implementation for the comment property. It's unlikely developers will need to override.

getDocAnchor

public String getDocAnchor()
Get the component's document anchor name. Used by Help to find the appropriate location in the documentation
Specified by:
getDocAnchor in interface JMeterGUIComponent
Returns:
Document anchor (#ref) for the component.

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

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

getNode

protected TreeNode getNode()
Provides a default implementation for the node property. It is unlikely developers would need to override this method.

getPrintableComponent

public JComponent getPrintableComponent()
Subclasses need to over-ride this method, if they wish to return something other than the Visualizer itself.
Specified by:
getPrintableComponent in interface Printable
Returns:
this object

getStaticLabel

public 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.
Specified by:
getStaticLabel in interface JMeterGUIComponent
Returns:
GUI label for 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

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 pane
verticalPolicy - the vertical scroll policy
horizontalPolicy - the horizontal scroll policy
Returns:
a JScrollPane containing the specified component

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

setComment

public void setComment(String comment)
Provides a default implementation for setting the comment property. It's unlikely developers will need to override.

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

setName

public void setName(String name)
Provides a default implementation for setting the name property. It's unlikely developers will need to override.
Specified by:
setName in interface JMeterGUIComponent

setNode

public void setNode(TreeNode 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

Copyright © 1998-2010 Apache Software Foundation. All Rights Reserved.