|
Apache JMeter 2.0.1.20050615 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.awt.Component
java.awt.Container
javax.swing.JComponent
javax.swing.JPanel
org.apache.jmeter.gui.AbstractJMeterGuiComponent
org.apache.jmeter.visualizers.gui.AbstractVisualizer
This is the base class for JMeter GUI components which can display test results in some way. It provides the following conveniences to developers:
JMeterGUIComponent
interface that allows your Gui visualizer to "plug-in" to the JMeter
GUI environment. Provides implementations for the following methods:
configure(TestElement)
.
Any additional parameters of your Visualizer need to be handled by
you.createTestElement()
.
For most purposes, the default
ResultCollector
created by this method is sufficient.getMenuCategories()
.
To control where in the GUI your visualizer can be added.modifyTestElement(TestElement)
.
Again, additional parameters you require have to be handled by
you.createPopupMenu()
.makeTitlePanel()
. Returns a panel that includes the name
of the component, and a FilePanel that allows users to control what
file samples are logged to.getModel()
and setModel(ResultCollector)
methods
for setting and getting the model class that handles the receiving
and logging of sample results.add(SampleResult)
method and display the results as you see fit. This AbstractVisualizer and
the default ResultCollector
handle logging and registering to receive SampleEvents for you - all you need
to do is include the JPanel created by makeTitlePanel somewhere in your gui
to allow users set the log file.
If you are doing more than that, you may need to extend
ResultCollector
as well
and modify the configure(TestElement)
,
modifyTestElement(TestElement)
, and createTestElement()
methods to create and modify your alternate ResultCollector. For an example
of this, see the
MailerVisualizer
.
Nested Class Summary |
Nested classes inherited from class javax.swing.JPanel |
JPanel.AccessibleJPanel |
Nested classes inherited from class javax.swing.JComponent |
JComponent.AccessibleJComponent |
Nested classes inherited from class java.awt.Container |
Container.AccessibleAWTContainer |
Nested classes inherited from class java.awt.Component |
Component.AccessibleAWTComponent, Component.BltBufferStrategy, Component.FlipBufferStrategy |
Field Summary | |
protected ResultCollector |
collector
|
Fields inherited from class javax.swing.JComponent |
accessibleContext, 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 |
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 | |
AbstractVisualizer()
|
Method Summary | |
void |
configure(TestElement el)
A newly created gui component can be initialized with the contents of a Test Element object by calling this method. |
protected void |
configureTestElement(AbstractListenerElement mc)
This provides a convenience for extenders when they implement the JMeterGUIComponent.createTestElement() method. |
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 |
createTestElement()
JMeter test components are separated into a model and a GUI representation. |
protected JCheckBox |
getErrorLoggingCheckbox()
Gets the checkbox which selects whether or not only errors should be logged. |
String |
getFile()
Gets the filename which has been entered in the FilePanel. |
protected Component |
getFilePanel()
Gets the file panel which allows the user to save results to a file. |
Collection |
getMenuCategories()
This is the list of menu categories this gui component will be available under. |
protected ResultCollector |
getModel()
Provides access to the ResultCollector model class for extending implementations. |
protected Container |
makeTitlePanel()
Create a standard title section for JMeter components. |
void |
modifyTestElement(TestElement c)
GUI components are responsible for populating TestElements they create with the data currently held in the GUI components. |
void |
setFile(String filename)
Sets the filename which results will be saved to. |
protected void |
setModel(ResultCollector collector)
Provides extending classes the opportunity to set the ResultCollector model for the Visualizer. |
void |
stateChanged(ChangeEvent e)
Invoked when the target of the listener has changed its state. |
Methods inherited from class org.apache.jmeter.gui.AbstractJMeterGuiComponent |
clear, configureTestElement, createTitleLabel, getDocAnchor, getLabelResource, getName, getNamePanel, getNode, getStaticLabel, isEnabled, makeBorder, makeScrollPane, makeScrollPane, setEnabled, setName, setNode |
Methods inherited from class javax.swing.JPanel |
getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface org.apache.jmeter.visualizers.Visualizer |
add |
Field Detail |
protected ResultCollector collector
Constructor Detail |
public AbstractVisualizer()
Method Detail |
protected JCheckBox getErrorLoggingCheckbox()
makeTitlePanel()
, and the behavior is handled in this base
class.
protected ResultCollector getModel()
protected Component getFilePanel()
makeTitlePanel()
, and the
behavior is handled in this base class.
public void setFile(String filename)
filename
- the new filenamegetFilePanel()
public String getFile()
getFilePanel()
public JPopupMenu createPopupMenu()
This implementation returns menu items appropriate for most visualizer components.
createPopupMenu
in interface JMeterGUIComponent
public void stateChanged(ChangeEvent e)
stateChanged
in interface ChangeListener
e
- the event that has occurredpublic Collection getMenuCategories()
MenuFactory.LISTENERS
, which
is appropriate for most visualizer components.
getMenuCategories
in interface JMeterGUIComponent
MenuFactory
public TestElement createTestElement()
JMeterGUIComponent
createTestElement
in interface JMeterGUIComponent
public void modifyTestElement(TestElement c)
JMeterGUIComponent
modifyTestElement
in interface JMeterGUIComponent
c
- the TestElement to modifypublic void configure(TestElement el)
AbstractJMeterGuiComponent
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.
configure
in interface JMeterGUIComponent
configure
in class AbstractJMeterGuiComponent
el
- the TestElement to configureprotected void configureTestElement(AbstractListenerElement mc)
JMeterGUIComponent.createTestElement()
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
Test Elements, as that will best assure consistent behavior.
mc
- the TestElement being created.protected Container makeTitlePanel()
This method is typically added to the top of the component at the beginning of the component's init method.
makeTitlePanel
in class AbstractJMeterGuiComponent
protected void setModel(ResultCollector collector)
collector
-
|
Apache JMeter 2.0.1.20050615 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |