junit.extensions.awt
Interface ComponentFinder

All Known Implementing Classes:
DefaultComponentFinder

public interface ComponentFinder

Interface to support looking up existing components based on a number of different criteria.


Method Summary
 void closeWindows()
          Send close events to all available showing windows.
 boolean componentsMatch(java.awt.Component comp, ComponentReference ref)
          Determine the best we can whether the component is the one referred to by the reference.
 void discardComponent(java.awt.Component comp)
          Discard the given component from any future queries.
 void disposeWindows()
          Discard all currently available windows.
 void filterComponent(java.awt.Component comp)
          Don't return the given component in any queries.
 java.awt.Component findActivePopupMenu(java.awt.Component root, java.awt.Component invoker)
          Find the active popup menu invoked by the given component.
 java.awt.Component findComponent(ComponentReference ref)
          Attempt to find the given component.
 java.awt.Component findMenuItemByName(java.awt.Component root, java.lang.String name)
          Look up the first menu item below root with the given title.
 java.awt.Window findWindow(java.lang.String nameOrTitle)
          Find the first window with a name or title that matches the given string.
 java.awt.Window findWindowByName(java.lang.String name)
          Find the first window with the given name.
 java.awt.Window findWindowByTitle(java.lang.String pattern)
          Find the first window with the given title pattern.
 java.awt.Component getComponentFrame(java.awt.Component comp)
          Return the component's owning frame.
 java.lang.String getComponentFrameTitle(java.awt.Component comp)
          Returns the title of the frame for the given component, or null if none.
 java.lang.String getComponentName(java.awt.Component comp)
          Return the component's name.
 java.awt.Component getComponentParent(java.awt.Component comp)
          Look up the apparent parent of a component.
 java.awt.Component[] getComponents(java.awt.Container c)
          Include Windows and MenuElements.
 java.awt.Window getComponentWindow(java.awt.Component comp)
          Returns the parent window for the given component.
 java.awt.EventQueue getEventQueue(java.awt.Component comp)
          Return the AWT event queue for the given component.
 java.awt.Frame[] getFrames()
          Returns all available frames.
 java.lang.String getTag(java.awt.Component comp)
          Return a reasonable identifier for the given component.
 java.lang.Class getTestedClass(ComponentTester tester)
          Return the class tested by the given tester.
 ComponentTester getTester(java.lang.Class forClass)
          Return the tester registered for the given class, chaining up the inheritance tree if necessary.
 ComponentTester getTester(java.awt.Component comp)
          Return the tester registered for the given component's class.
 ComponentTester getTester(ComponentReference ref)
          Return the tester registered for the given component reference's class.
 java.awt.Window[] getWindows()
          Returns the set of all available windows.
 java.awt.Window[] getWindows(java.awt.Window parent)
          Returns all available windows under the given parent window.
 boolean isFiltered(java.awt.Component comp)
          Is the given component being filtered?
 void setFilterEnabled(boolean enable)
          Indicate whether to filter component lists.
 boolean stringMatch(java.lang.String pattern, java.lang.String actual)
          Return whether the given pattern matches the given string.
 

Method Detail

findComponent

public java.awt.Component findComponent(ComponentReference ref)
                                 throws ComponentNotFoundException
Attempt to find the given component.

findWindowByName

public java.awt.Window findWindowByName(java.lang.String name)
Find the first window with the given name.

findWindowByTitle

public java.awt.Window findWindowByTitle(java.lang.String pattern)
Find the first window with the given title pattern.

findWindow

public java.awt.Window findWindow(java.lang.String nameOrTitle)
Find the first window with a name or title that matches the given string.

findActivePopupMenu

public java.awt.Component findActivePopupMenu(java.awt.Component root,
                                              java.awt.Component invoker)
Find the active popup menu invoked by the given component.

findMenuItemByName

public java.awt.Component findMenuItemByName(java.awt.Component root,
                                             java.lang.String name)
Look up the first menu item below root with the given title.

componentsMatch

public boolean componentsMatch(java.awt.Component comp,
                               ComponentReference ref)
Determine the best we can whether the component is the one referred to by the reference.

getFrames

public java.awt.Frame[] getFrames()
Returns all available frames.

getWindows

public java.awt.Window[] getWindows(java.awt.Window parent)
Returns all available windows under the given parent window.

getWindows

public java.awt.Window[] getWindows()
Returns the set of all available windows.

getComponents

public java.awt.Component[] getComponents(java.awt.Container c)
Include Windows and MenuElements.

getComponentParent

public java.awt.Component getComponentParent(java.awt.Component comp)
Look up the apparent parent of a component.

getComponentWindow

public java.awt.Window getComponentWindow(java.awt.Component comp)
Returns the parent window for the given component.

getComponentFrameTitle

public java.lang.String getComponentFrameTitle(java.awt.Component comp)
Returns the title of the frame for the given component, or null if none.

getComponentFrame

public java.awt.Component getComponentFrame(java.awt.Component comp)
Return the component's owning frame. There will always one of these; even a frameless window will have a temporary frame generated for it.

getComponentName

public java.lang.String getComponentName(java.awt.Component comp)
Return the component's name.

getEventQueue

public java.awt.EventQueue getEventQueue(java.awt.Component comp)
Return the AWT event queue for the given component.

getTag

public java.lang.String getTag(java.awt.Component comp)
Return a reasonable identifier for the given component.

getTester

public ComponentTester getTester(ComponentReference ref)
Return the tester registered for the given component reference's class.

getTester

public ComponentTester getTester(java.awt.Component comp)
Return the tester registered for the given component's class.

getTester

public ComponentTester getTester(java.lang.Class forClass)
                          throws java.lang.IllegalArgumentException
Return the tester registered for the given class, chaining up the inheritance tree if necessary.

getTestedClass

public java.lang.Class getTestedClass(ComponentTester tester)
Return the class tested by the given tester.

isFiltered

public boolean isFiltered(java.awt.Component comp)
Is the given component being filtered?

filterComponent

public void filterComponent(java.awt.Component comp)
Don't return the given component in any queries. Makes the given component unavailable unless filtering is turned off.

setFilterEnabled

public void setFilterEnabled(boolean enable)
Indicate whether to filter component lists.

discardComponent

public void discardComponent(java.awt.Component comp)
Discard the given component from any future queries.

disposeWindows

public void disposeWindows()
Discard all currently available windows.

closeWindows

public void closeWindows()
Send close events to all available showing windows.

stringMatch

public boolean stringMatch(java.lang.String pattern,
                           java.lang.String actual)
Return whether the given pattern matches the given string.