Package org.netbeans.jemmy.operators

Class JMenuBarOperator

  • All Implemented Interfaces:
    Outputable, Timeoutable
    public class JMenuBarOperator
extends JComponentOperator
implements Outputable, Timeoutable


    Timeouts used:
    JMenuOperator.WaitBeforePopupTimeout - time to sleep before popup expanding
    JMenuOperator.WaitPopupTimeout - time to wait popup displayed
    ComponentOperator.WaitComponentTimeout - time to wait button displayed
    .
    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

      • JMenuBarOperator

        public JMenuBarOperator​(javax.swing.JMenuBar b)
        Constructor.
        Parameters:
        b - a component

      • JMenuBarOperator

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

      • JMenuBarOperator

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

      • JMenuBarOperator

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

    • Method Detail

      • findJMenuBar

        public static javax.swing.JMenuBar findJMenuBar​(javax.swing.JFrame frame)
        Searches JMenuBar in frame.
        Parameters:
        frame - a container
        Returns:
        found JMenuBar

      • findJMenuBar

        public static javax.swing.JMenuBar findJMenuBar​(javax.swing.JDialog dialog)
        Searches JMenuBar in dialog.
        Parameters:
        dialog - a container
        Returns:
        found JMenuBar

      • waitJMenuBar

        public static javax.swing.JMenuBar waitJMenuBar​(java.awt.Container cont)
        Searches JMenuBar in container.
        Parameters:
        cont - a container
        Returns:
        found JMenuBar
        Throws:
        TimeoutExpiredException

      • waitJMenuBar

        public static javax.swing.JMenuBar waitJMenuBar​(javax.swing.JFrame frame)
        Waits JMenuBar in frame.
        Parameters:
        frame - a container
        Returns:
        found JMenuBar
        Throws:
        TimeoutExpiredException

      • waitJMenuBar

        public static javax.swing.JMenuBar waitJMenuBar​(javax.swing.JDialog dialog)
        Waits JMenuBar in dialog.
        Parameters:
        dialog - a container
        Returns:
        found JMenuBar
        Throws:
        TimeoutExpiredException

      • findJMenuBar

        public static javax.swing.JMenuBar findJMenuBar​(java.awt.Container cont)
        Waits JMenuBar in container.
        Parameters:
        cont - a container
        Returns:
        found JMenuBar

      • copyEnvironment

        public void copyEnvironment​(Operator anotherOperator)
        Description copied from class: Operator
        Copies all environment (output, timeouts, visualizer) from another operator.
        Overrides:
        copyEnvironment in class ComponentOperator
        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.
        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 pushMenu(String, String) or pushMenu(String, 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.
        Parameters:
        path - String menupath representation ("File/New", for example).
        delim - String menupath divider ("/").
        Returns:
        Last pushed JMenuItem.
        Throws:
        TimeoutExpiredException

      • 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,
                                         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,
                                         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)
        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,
                                      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,
                                      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)
        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

      • closeSubmenus

        public void closeSubmenus()
        Closes all expanded submenus.

      • getDump

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

      • add

        public javax.swing.JMenu add​(javax.swing.JMenu jMenu)
        Maps JMenuBar.add(JMenu) through queue

      • getComponentIndex

        public int getComponentIndex​(java.awt.Component component)
        Maps JMenuBar.getComponentIndex(Component) through queue

      • getHelpMenu

        public javax.swing.JMenu getHelpMenu()
        Maps JMenuBar.getHelpMenu() through queue

      • getMargin

        public java.awt.Insets getMargin()
        Maps JMenuBar.getMargin() through queue

      • getMenu

        public javax.swing.JMenu getMenu​(int i)
        Maps JMenuBar.getMenu(int) through queue

      • getMenuCount

        public int getMenuCount()
        Maps JMenuBar.getMenuCount() through queue

      • getSelectionModel

        public javax.swing.SingleSelectionModel getSelectionModel()
        Maps JMenuBar.getSelectionModel() through queue

      • getSubElements

        public javax.swing.MenuElement[] getSubElements()
        Maps JMenuBar.getSubElements() through queue

      • getUI

        public javax.swing.plaf.MenuBarUI getUI()
        Maps JMenuBar.getUI() through queue

      • isBorderPainted

        public boolean isBorderPainted()
        Maps JMenuBar.isBorderPainted() through queue

      • isSelected

        public boolean isSelected()
        Maps JMenuBar.isSelected() through queue

      • menuSelectionChanged

        public void menuSelectionChanged​(boolean b)
        Maps JMenuBar.menuSelectionChanged(boolean) through queue

      • processKeyEvent

        public void processKeyEvent​(java.awt.event.KeyEvent keyEvent,
                            javax.swing.MenuElement[] menuElement,
                            javax.swing.MenuSelectionManager menuSelectionManager)
        Maps JMenuBar.processKeyEvent(KeyEvent, MenuElement[], MenuSelectionManager) through queue

      • processMouseEvent

        public void processMouseEvent​(java.awt.event.MouseEvent mouseEvent,
                              javax.swing.MenuElement[] menuElement,
                              javax.swing.MenuSelectionManager menuSelectionManager)
        Maps JMenuBar.processMouseEvent(MouseEvent, MenuElement[], MenuSelectionManager) through queue

      • setBorderPainted

        public void setBorderPainted​(boolean b)
        Maps JMenuBar.setBorderPainted(boolean) through queue

      • setHelpMenu

        public void setHelpMenu​(javax.swing.JMenu jMenu)
        Maps JMenuBar.setHelpMenu(JMenu) through queue

      • setMargin

        public void setMargin​(java.awt.Insets insets)
        Maps JMenuBar.setMargin(Insets) through queue

      • setSelected

        public void setSelected​(java.awt.Component component)
        Maps JMenuBar.setSelected(Component) through queue

      • setSelectionModel

        public void setSelectionModel​(javax.swing.SingleSelectionModel singleSelectionModel)
        Maps JMenuBar.setSelectionModel(SingleSelectionModel) through queue

      • setUI

        public void setUI​(javax.swing.plaf.MenuBarUI menuBarUI)
        Maps JMenuBar.setUI(MenuBarUI) through queue