Package org.netbeans.jemmy.operators

Class JMenuOperator

  • All Implemented Interfaces:
    Outputable, Timeoutable
    public class JMenuOperator
extends JMenuItemOperator
implements Outputable, Timeoutable


    Timeouts used:
    JMenuOperator.WaitBeforePopupTimeout - time to sleep before popup expanding
    JMenuOperator.WaitPopupTimeout - time to wait popup displayed
    JMenuOperator.PushMenuTimeout - time for the whole menu operation
    JMenuItemOperator.PushMenuTimeout - time between button pressing and releasing
    ComponentOperator.WaitComponentTimeout - time to wait button displayed
    ComponentOperator.WaitComponentEnabledTimeout - time to wait button enabled
    .
    Author:
    Alexandre Iline (alexandre.iline@sun.com)
    See Also:
    Timeouts

    • Field Detail

      • SUBMENU_PREFIX_DPROP

        public static final java.lang.String SUBMENU_PREFIX_DPROP
        Identifier for a "submenu" properties.
        See Also:
        getDump(), Constant Field Values

    • Constructor Detail

      • JMenuOperator

        public JMenuOperator​(javax.swing.JMenu menu)
        Constructor.
        Parameters:
        menu - a component

      • JMenuOperator

        public JMenuOperator​(ContainerOperator cont,
                     ComponentChooser chooser,
                     int index)
        Constructs a JMenuOperator object.
        Parameters:
        cont - a container
        chooser - a component chooser specifying searching criteria.
        index - an index between appropriate ones.

      • JMenuOperator

        public JMenuOperator​(ContainerOperator cont,
                     ComponentChooser chooser)
        Constructs a JMenuOperator object.
        Parameters:
        cont - a container
        chooser - a component chooser specifying searching criteria.

      • JMenuOperator

        public JMenuOperator​(ContainerOperator cont,
                     int index)
        Constructor. Waits component in container first. Uses cont's timeout and output for waiting and to init operator.
        Parameters:
        cont - a container
        index - Ordinal component index.
        Throws:
        TimeoutExpiredException

      • JMenuOperator

        public JMenuOperator​(ContainerOperator cont)
        Constructor. Waits component in container first. Uses cont's timeout and output for waiting and to init operator.
        Parameters:
        cont - a container
        Throws:
        TimeoutExpiredException

    • Method Detail

      • findJMenu

        public static javax.swing.JMenu findJMenu​(java.awt.Container cont,
                                          ComponentChooser chooser,
                                          int index)
        Searches JMenu in container.
        Parameters:
        cont - Container to search component in.
        chooser - org.netbeans.jemmy.ComponentChooser implementation.
        index - Ordinal component index.
        Returns:
        JMenu instance or null if component was not found.

      • findJMenu

        public static javax.swing.JMenu findJMenu​(java.awt.Container cont,
                                          ComponentChooser chooser)
        Searches 0'th JMenu in container.
        Parameters:
        cont - Container to search component in.
        chooser - org.netbeans.jemmy.ComponentChooser implementation.
        Returns:
        JMenu instance or null if component was not found.

      • findJMenu

        public static javax.swing.JMenu findJMenu​(java.awt.Container cont,
                                          java.lang.String text,
                                          boolean ce,
                                          boolean ccs,
                                          int index)
        Searches JMenu by text.
        Parameters:
        cont - Container to search component in.
        text - Button text. If null, contents is not checked.
        ce - Compare text exactly.
        ccs - Compare text case sensitively.
        index - Ordinal component index.
        Returns:
        JMenu instance or null if component was not found.
        See Also:
        Operator.isCaptionEqual(String, String, boolean, boolean)

      • findJMenu

        public static javax.swing.JMenu findJMenu​(java.awt.Container cont,
                                          java.lang.String text,
                                          boolean ce,
                                          boolean ccs)
        Searches JMenu by text.
        Parameters:
        cont - Container to search component in.
        text - Button text. If null, contents is not checked.
        ce - Compare text exactly.
        ccs - Compare text case sensitively.
        Returns:
        JMenu instance or null if component was not found.
        See Also:
        Operator.isCaptionEqual(String, String, boolean, boolean)

      • waitJMenu

        public static javax.swing.JMenu waitJMenu​(java.awt.Container cont,
                                          ComponentChooser chooser,
                                          int index)
        Waits JMenu in container.
        Parameters:
        cont - Container to search component in.
        chooser - org.netbeans.jemmy.ComponentChooser implementation.
        index - Ordinal component index.
        Returns:
        JMenu instance.
        Throws:
        TimeoutExpiredException

      • waitJMenu

        public static javax.swing.JMenu waitJMenu​(java.awt.Container cont,
                                          ComponentChooser chooser)
        Waits 0'th JMenu in container.
        Parameters:
        cont - Container to search component in.
        chooser - org.netbeans.jemmy.ComponentChooser implementation.
        Returns:
        JMenu instance.
        Throws:
        TimeoutExpiredException

      • waitJMenu

        public static javax.swing.JMenu waitJMenu​(java.awt.Container cont,
                                          java.lang.String text,
                                          boolean ce,
                                          boolean ccs,
                                          int index)
        Waits JMenu by text.
        Parameters:
        cont - Container to search component in.
        text - Button text. If null, contents is not checked.
        ce - Compare text exactly.
        ccs - Compare text case sensitively.
        index - Ordinal component index.
        Returns:
        JMenu instance.
        Throws:
        TimeoutExpiredException
        See Also:
        Operator.isCaptionEqual(String, String, boolean, boolean)

      • waitJMenu

        public static javax.swing.JMenu waitJMenu​(java.awt.Container cont,
                                          java.lang.String text,
                                          boolean ce,
                                          boolean ccs)
        Waits JMenu by text.
        Parameters:
        cont - Container to search component in.
        text - Button text. If null, contents is not checked.
        ce - Compare text exactly.
        ccs - Compare text case sensitively.
        Returns:
        JMenu instance.
        Throws:
        TimeoutExpiredException
        See Also:
        Operator.isCaptionEqual(String, String, boolean, boolean)

      • performInit

        public static void performInit()

      • copyEnvironment

        public void copyEnvironment​(Operator anotherOperator)
        Description copied from class: Operator
        Copies all environment (output, timeouts, visualizer) from another operator.
        Overrides:
        copyEnvironment in class AbstractButtonOperator
        Parameters:
        anotherOperator - an operator to copy the environment to.

      • pushMenu

        public javax.swing.JMenuItem pushMenu​(ComponentChooser[] choosers)
        Pushes menu.
        Parameters:
        choosers - Array of choosers to find menuItems to push.
        Returns:
        Last pushed JMenuItem.
        Throws:
        TimeoutExpiredException

      • pushMenuNoBlock

        public void pushMenuNoBlock​(ComponentChooser[] choosers)
        Executes pushMenu(choosers) in a separate thread.
        Parameters:
        choosers - Array of choosers to find menuItems to push.
        See Also:
        pushMenu(ComponentChooser[])

      • pushMenu

        public javax.swing.JMenuItem pushMenu​(java.lang.String[] names,
                                      Operator.StringComparator comparator)
        Pushes menu.
        Parameters:
        names - an array of menu texts.
        comparator - a string comparision algorithm
        Returns:
        Last pushed JMenuItem.
        Throws:
        TimeoutExpiredException

      • pushMenu

        public javax.swing.JMenuItem pushMenu​(java.lang.String[] names,
                                      boolean ce,
                                      boolean ccs)
        Deprecated.
        Use pushMenu(String[]) or pushMenu(String[], StringComparator)
        Pushes menu.
        Parameters:
        names - Menu items texts.
        ce - Compare text exactly.
        ccs - Compare text case sensitively.
        Returns:
        Last pushed JMenuItem.
        Throws:
        TimeoutExpiredException
        See Also:
        Operator.isCaptionEqual(String, String, boolean, boolean)

      • pushMenuNoBlock

        public void pushMenuNoBlock​(java.lang.String[] names,
                            Operator.StringComparator comparator)
        Executes pushMenu(names, ce, ccs) in a separate thread.
        Parameters:
        names - an array of menu texts.
        comparator - a string comparision algorithm

      • pushMenuNoBlock

        public void pushMenuNoBlock​(java.lang.String[] names,
                            boolean ce,
                            boolean ccs)
        Deprecated.
        Use pushMenuNoBlock(String[]) or pushMenuNoBlock(String[], StringComparator)
        Executes pushMenu(names, ce, ccs) in a separate thread.
        Parameters:
        names - Menu items texts.
        ce - Compare text exactly.
        ccs - Compare text case sensitively.
        See Also:
        pushMenu(String[], boolean,boolean)

      • pushMenu

        public javax.swing.JMenuItem pushMenu​(java.lang.String[] names)
        Pushes menu. Uses StringComparator assigned to this object,
        Parameters:
        names - Menu items texts.
        Returns:
        Last pushed JMenuItem.
        Throws:
        TimeoutExpiredException

      • pushMenuNoBlock

        public void pushMenuNoBlock​(java.lang.String[] names)
        Executes pushMenu(names) in a separate thread.
        Parameters:
        names - Menu items texts.
        See Also:
        pushMenu(String[])

      • pushMenu

        public javax.swing.JMenuItem pushMenu​(java.lang.String path,
                                      java.lang.String delim,
                                      Operator.StringComparator comparator)
        Pushes menu.
        Parameters:
        path - a menu path.
        delim - a path delimiter.
        comparator - a string comparision algorithm
        Returns:
        Last pushed JMenuItem.
        Throws:
        TimeoutExpiredException

      • pushMenu

        public javax.swing.JMenuItem pushMenu​(java.lang.String path,
                                      Operator.StringComparator comparator)
        Pushes menu. Uses PathParser assigned to this operator.
        Parameters:
        path - a menu path.
        comparator - a string comparision algorithm
        Returns:
        Last pushed JMenuItem.
        Throws:
        TimeoutExpiredException

      • pushMenu

        public javax.swing.JMenuItem pushMenu​(java.lang.String path,
                                      java.lang.String delim,
                                      boolean ce,
                                      boolean ccs)
        Deprecated.
        Use pushMenuNoBlock(String) or pushMenuNoBlock(String, StringComparator)
        Pushes menu.
        Parameters:
        path - String menupath representation ("File/New", for example).
        delim - String menupath divider ("/").
        ce - Compare text exactly.
        ccs - Compare text case sensitively.
        Returns:
        Last pushed JMenuItem.
        Throws:
        TimeoutExpiredException
        See Also:
        Operator.isCaptionEqual(String, String, boolean, boolean)

      • pushMenuNoBlock

        public void pushMenuNoBlock​(java.lang.String path,
                            java.lang.String delim,
                            Operator.StringComparator comparator)
        Executes pushMenu(names, delim, comparator) in a separate thread.
        Parameters:
        path - a menu path.
        delim - a path delimiter.
        comparator - a string comparision algorithm

      • pushMenuNoBlock

        public void pushMenuNoBlock​(java.lang.String path,
                            Operator.StringComparator comparator)
        Executes pushMenu(names, comparator) in a separate thread. Uses PathParser assigned to this operator.
        Parameters:
        path - a menu path.
        comparator - a string comparision algorithm

      • pushMenuNoBlock

        public void pushMenuNoBlock​(java.lang.String path,
                            java.lang.String delim,
                            boolean ce,
                            boolean ccs)
        Deprecated.
        Use pushMenuNoBlock(String, String) or pushMenuNoBlock(String, String, StringComparator)
        Executes pushMenu(path, delim, ce, ccs) in a separate thread.
        Parameters:
        path - String menupath representation ("File/New", for example).
        delim - String menupath divider ("/").
        ce - Compare text exactly.
        ccs - Compare text case sensitively.
        See Also:
        pushMenu(org.netbeans.jemmy.ComponentChooser[])

      • pushMenu

        public javax.swing.JMenuItem pushMenu​(java.lang.String path,
                                      java.lang.String delim)
        Pushes menu. Uses StringComparator assigned to this object,
        Parameters:
        path - String menupath representation ("File/New", for example).
        delim - String menupath divider ("/").
        Returns:
        Last pushed JMenuItem.
        Throws:
        TimeoutExpiredException
        See Also:
        Operator.isCaptionEqual(String, String, boolean, boolean)

      • pushMenu

        public javax.swing.JMenuItem pushMenu​(java.lang.String path)
        Pushes menu. Uses PathParser assigned to this operator.
        Parameters:
        path - String menupath representation ("File/New", for example).
        Returns:
        Last pushed JMenuItem.
        Throws:
        TimeoutExpiredException

      • pushMenuNoBlock

        public void pushMenuNoBlock​(java.lang.String path,
                            java.lang.String delim)
        Executes pushMenu(path, delim) in a separate thread.
        Parameters:
        path - String menupath representation ("File/New", for example).
        delim - String menupath divider ("/").

      • pushMenuNoBlock

        public void pushMenuNoBlock​(java.lang.String path)
        Executes pushMenu(path) in a separate thread.
        Parameters:
        path - String menupath representation ("File/New", for example).

      • showMenuItems

        public JMenuItemOperator[] showMenuItems​(java.lang.String[] path,
                                         Operator.StringComparator comparator)
        Shows submenu of menu specified by a path parameter.
        Parameters:
        path - an array of menu texts.
        comparator - a string comparision algorithm
        Returns:
        an array of operators created tor items from the submenu.
        Throws:
        TimeoutExpiredException

      • showMenuItems

        public JMenuItemOperator[] showMenuItems​(java.lang.String[] path)
        Shows submenu of menu specified by a path parameter. Uses StringComparator assigned to the operator.
        Parameters:
        path - an array of menu texts.
        Returns:
        an array of operators created tor items from the submenu.
        Throws:
        TimeoutExpiredException

      • showMenuItems

        public JMenuItemOperator[] showMenuItems​(java.lang.String path,
                                         java.lang.String delim,
                                         Operator.StringComparator comparator)
        Shows submenu of menu specified by a path parameter.
        Parameters:
        path - a string identifying the menu path.
        delim - a path delimiter.
        comparator - a string comparision algorithm
        Returns:
        an array of operators created tor items from the submenu.
        Throws:
        TimeoutExpiredException

      • showMenuItems

        public JMenuItemOperator[] showMenuItems​(java.lang.String path,
                                         java.lang.String delim)
        Shows submenu of menu specified by a path parameter. Uses StringComparator assigned to the operator.
        Parameters:
        path - a string identifying the menu path.
        delim - a path delimiter.
        Returns:
        an array of operators created tor items from the submenu.
        Throws:
        TimeoutExpiredException

      • showMenuItems

        public JMenuItemOperator[] showMenuItems​(java.lang.String path,
                                         Operator.StringComparator comparator)
        Shows submenu of menu specified by a path parameter. Uses PathParser assigned to this operator.
        Parameters:
        path - a string identifying the menu path.
        comparator - a string comparision algorithm
        Returns:
        an array of operators created tor items from the submenu.
        Throws:
        TimeoutExpiredException

      • showMenuItems

        public JMenuItemOperator[] showMenuItems​(java.lang.String path)
        Shows submenu of menu specified by a path parameter. Uses PathParser assigned to this operator. Uses StringComparator assigned to the operator.
        Parameters:
        path - a string identifying the menu path.
        Returns:
        an array of operators created tor items from the submenu.
        Throws:
        TimeoutExpiredException

      • showMenuItem

        public JMenuItemOperator showMenuItem​(java.lang.String[] path,
                                      Operator.StringComparator comparator)
        Expends all menus to show menu item specified by a path parameter.
        Parameters:
        path - an array of menu texts.
        comparator - a string comparision algorithm
        Returns:
        an operator for the last menu item in path.
        Throws:
        TimeoutExpiredException

      • showMenuItem

        public JMenuItemOperator showMenuItem​(java.lang.String[] path)
        Expands all menus to show menu item specified by a path parameter.
        Parameters:
        path - an array of menu texts.
        Returns:
        an operator for the last menu item in path.
        Throws:
        TimeoutExpiredException

      • showMenuItem

        public JMenuItemOperator showMenuItem​(java.lang.String path,
                                      java.lang.String delim,
                                      Operator.StringComparator comparator)
        Expands all menus to show menu item specified by a path parameter.
        Parameters:
        path - a string identifying the menu path.
        delim - a path delimiter.
        comparator - a string comparision algorithm
        Returns:
        an operator for the last menu item in path.
        Throws:
        TimeoutExpiredException

      • showMenuItem

        public JMenuItemOperator showMenuItem​(java.lang.String path,
                                      java.lang.String delim)
        Expands all menus to show menu item specified by a path parameter. Uses StringComparator assigned to the operator.
        Parameters:
        path - a string identifying the menu path.
        delim - a path delimiter.
        Returns:
        an operator for the last menu item in path.
        Throws:
        TimeoutExpiredException

      • showMenuItem

        public JMenuItemOperator showMenuItem​(java.lang.String path,
                                      Operator.StringComparator comparator)
        Expands all menus to show menu item specified by a path parameter. Uses PathParser assigned to this operator.
        Parameters:
        path - a string identifying the menu path.
        comparator - a string comparision algorithm
        Returns:
        an operator for the last menu item in path.
        Throws:
        TimeoutExpiredException

      • showMenuItem

        public JMenuItemOperator showMenuItem​(java.lang.String path)
        Expands all menus to show menu item specified by a path parameter. Uses PathParser assigned to this operator. Uses StringComparator assigned to the operator.
        Parameters:
        path - a string identifying the menu path.
        Returns:
        an array of operators created tor items from the submenu.
        Throws:
        TimeoutExpiredException

      • getDump

        public java.util.Hashtable getDump()
        Description copied from class: AbstractButtonOperator
        Returns information about component.
        Overrides:
        getDump in class JMenuItemOperator
        Returns:
        a Hashtable containing name-value pairs.

      • add

        public javax.swing.JMenuItem add​(java.lang.String string)
        Maps JMenu.add(String) through queue

      • add

        public javax.swing.JMenuItem add​(javax.swing.Action action)
        Maps JMenu.add(Action) through queue

      • add

        public javax.swing.JMenuItem add​(javax.swing.JMenuItem jMenuItem)
        Maps JMenu.add(JMenuItem) through queue

      • addMenuListener

        public void addMenuListener​(javax.swing.event.MenuListener menuListener)
        Maps JMenu.addMenuListener(MenuListener) through queue

      • addSeparator

        public void addSeparator()
        Maps JMenu.addSeparator() through queue

      • getDelay

        public int getDelay()
        Maps JMenu.getDelay() through queue

      • getItem

        public javax.swing.JMenuItem getItem​(int i)
        Maps JMenu.getItem(int) through queue

      • getItemCount

        public int getItemCount()
        Maps JMenu.getItemCount() through queue

      • getMenuComponent

        public java.awt.Component getMenuComponent​(int i)
        Maps JMenu.getMenuComponent(int) through queue

      • getMenuComponentCount

        public int getMenuComponentCount()
        Maps JMenu.getMenuComponentCount() through queue

      • getMenuComponents

        public java.awt.Component[] getMenuComponents()
        Maps JMenu.getMenuComponents() through queue

      • getPopupMenu

        public javax.swing.JPopupMenu getPopupMenu()
        Maps JMenu.getPopupMenu() through queue

      • insert

        public void insert​(java.lang.String string,
                   int i)
        Maps JMenu.insert(String, int) through queue

      • insert

        public javax.swing.JMenuItem insert​(javax.swing.Action action,
                                    int i)
        Maps JMenu.insert(Action, int) through queue

      • insert

        public javax.swing.JMenuItem insert​(javax.swing.JMenuItem jMenuItem,
                                    int i)
        Maps JMenu.insert(JMenuItem, int) through queue

      • insertSeparator

        public void insertSeparator​(int i)
        Maps JMenu.insertSeparator(int) through queue

      • isMenuComponent

        public boolean isMenuComponent​(java.awt.Component component)
        Maps JMenu.isMenuComponent(Component) through queue

      • isPopupMenuVisible

        public boolean isPopupMenuVisible()
        Maps JMenu.isPopupMenuVisible() through queue

      • isTearOff

        public boolean isTearOff()
        Maps JMenu.isTearOff() through queue

      • isTopLevelMenu

        public boolean isTopLevelMenu()
        Maps JMenu.isTopLevelMenu() through queue

      • remove

        public void remove​(javax.swing.JMenuItem jMenuItem)
        Maps JMenu.remove(JMenuItem) through queue

      • removeMenuListener

        public void removeMenuListener​(javax.swing.event.MenuListener menuListener)
        Maps JMenu.removeMenuListener(MenuListener) through queue

      • setDelay

        public void setDelay​(int i)
        Maps JMenu.setDelay(int) through queue

      • setMenuLocation

        public void setMenuLocation​(int i,
                            int i1)
        Maps JMenu.setMenuLocation(int, int) through queue

      • setPopupMenuVisible

        public void setPopupMenuVisible​(boolean b)
        Maps JMenu.setPopupMenuVisible(boolean) through queue