|
Apache JMeter 2.0.1.20050615 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.jmeter.gui.GuiPackage
GuiPackage is a static class that provides convenient access to information
about the current state of JMeter's GUI. Any GUI class can grab a handle to
GuiPackage by calling the static method getInstance()
and then use
it to query the GUI about it's state. When actions, for instance, need to
affect the GUI, they typically use GuiPackage to get access to different
parts of the GUI.
Method Summary | |
HashTree |
addSubTree(HashTree subTree)
Add a subtree to the currently selected node. |
TestElement |
createTestElement(Class guiClass,
Class testClass)
Create a TestElement corresponding to the specified GUI class. |
TestElement |
createTestElement(String objClass)
Create a TestElement for a GUI or TestBean class. |
void |
displayPopUp(Component invoker,
MouseEvent e,
JPopupMenu popup)
Display the specified popup menu at the location specified by a mouse event with the specified source component. |
void |
displayPopUp(MouseEvent e,
JPopupMenu popup)
Display the specified popup menu with the source component and location from the specified mouse event. |
TestElement |
getCurrentElement()
|
JMeterGUIComponent |
getCurrentGui()
Convenience method for grabbing the gui for the current node. |
JMeterTreeNode |
getCurrentNode()
|
HashTree |
getCurrentSubTree()
Get the currently selected subtree. |
JMeterGUIComponent |
getGui(TestElement node)
Get a JMeterGUIComponent for the specified test element. |
JMeterGUIComponent |
getGui(TestElement node,
Class guiClass,
Class testClass)
Get a JMeterGUIComponent for the specified test element. |
static GuiPackage |
getInstance()
Retrieve the singleton GuiPackage instance. |
static GuiPackage |
getInstance(JMeterTreeListener listener,
JMeterTreeModel treeModel)
When GuiPackage is requested for the first time, it should be given handles to JMeter's Tree Listener and TreeModel. |
MainFrame |
getMainFrame()
Get the main JMeter frame. |
JMeterTreeNode |
getNodeOf(TestElement userObject)
Find the JMeterTreeNode for a certain TestElement object. |
ValueReplacer |
getReplacer()
Get a ValueReplacer for the test tree. |
JMeterTreeListener |
getTreeListener()
Get the listener for JMeter's test tree. |
JMeterTreeModel |
getTreeModel()
Get the model for JMeter's test tree. |
boolean |
isDirty()
Retrieves the state of the 'dirty' property, a flag that indicates if there are test tree components that have been modified since they were last saved. |
void |
localeChanged(LocaleChangeEvent event)
|
void |
removeNode(TestElement node)
Remove a test element from the tree. |
void |
setDirty(boolean dirty)
The dirty property is a flag that indicates whether there are parts of JMeter's test tree that the user has not saved since last modification. |
void |
setMainFrame(MainFrame newMainFrame)
Set the main JMeter frame. |
void |
setTreeListener(JMeterTreeListener newTreeListener)
Set the listener for JMeter's test tree. |
void |
setTreeModel(JMeterTreeModel newTreeModel)
Set the model for JMeter's test tree. |
void |
updateCurrentGui()
Update the GUI for the currently selected node. |
void |
updateCurrentNode()
This method should be called in order for GuiPackage to change the current node. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
public static GuiPackage getInstance()
public static GuiPackage getInstance(JMeterTreeListener listener, JMeterTreeModel treeModel)
listener
- the TreeListener for JMeter's test treetreeModel
- the model for JMeter's test tree
public JMeterGUIComponent getGui(TestElement node)
UnsharedComponent
, that shared component will
be returned. Otherwise, a new instance of the component will be created.
The TestElement's GUI_CLASS property will be used to determine the
appropriate type of GUI component to use.
node
- the test element which this GUI is being created for
public JMeterGUIComponent getGui(TestElement node, Class guiClass, Class testClass)
UnsharedComponent
, that shared component will
be returned. Otherwise, a new instance of the component will be created.
node
- the test element which this GUI is being created forguiClass
- the fully qualifed class name of the GUI component which
will be created if it doesn't already existtestClass
- the fully qualifed class name of the test elements which
have to be edited by the returned GUI component
public void removeNode(TestElement node)
node
- the test element being removedpublic JMeterGUIComponent getCurrentGui()
public JMeterTreeNode getNodeOf(TestElement userObject)
userObject
- the test element to search for
public TestElement createTestElement(Class guiClass, Class testClass)
guiClass
- the fully qualified class name of the GUI component
or a TestBean class for TestBeanGUIs.testClass
- the fully qualified class name of the test elements
edited by this GUI component.
public TestElement createTestElement(String objClass)
This is a utility method to help actions do with one single String parameter.
objClass
- the fully qualified class name of the GUI component or of
the TestBean subclass for which a TestBeanGUI is wanted.
public void updateCurrentGui()
public void updateCurrentNode()
public JMeterTreeNode getCurrentNode()
public TestElement getCurrentElement()
public void setDirty(boolean dirty)
dirty
- the new value of the dirty flagpublic boolean isDirty()
public HashTree addSubTree(HashTree subTree) throws IllegalUserActionException
subTree
- the subtree to add.
IllegalUserActionException
- if a subtree cannot be added to the
currently selected nodepublic HashTree getCurrentSubTree()
public JMeterTreeModel getTreeModel()
public void setTreeModel(JMeterTreeModel newTreeModel)
newTreeModel
- the new JMeter tree modelpublic ValueReplacer getReplacer()
public void setMainFrame(MainFrame newMainFrame)
newMainFrame
- the new JMeter main framepublic MainFrame getMainFrame()
public void setTreeListener(JMeterTreeListener newTreeListener)
newTreeListener
- the new JMeter test tree listenerpublic JMeterTreeListener getTreeListener()
public void displayPopUp(MouseEvent e, JPopupMenu popup)
e
- the mouse event causing this popup to be displayedpopup
- the popup menu to displaypublic void displayPopUp(Component invoker, MouseEvent e, JPopupMenu popup)
invoker
- the source componente
- the mouse event causing this popup to be displayedpopup
- the popup menu to displaypublic void localeChanged(LocaleChangeEvent event)
localeChanged
in interface LocaleChangeListener
|
Apache JMeter 2.0.1.20050615 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |