Class JTextComponentOperator

java.lang.Object
org.netbeans.jemmy.operators.Operator
org.netbeans.jemmy.operators.ComponentOperator
org.netbeans.jemmy.operators.ContainerOperator
org.netbeans.jemmy.operators.JComponentOperator
org.netbeans.jemmy.operators.JTextComponentOperator
All Implemented Interfaces:
Outputable, Timeoutable
Direct Known Subclasses:
JEditorPaneOperator, JTextAreaOperator, JTextFieldOperator
public class JTextComponentOperator extends JComponentOperator implements Timeoutable, Outputable
Class provides basic functions to operate with JTextComponent (selection, typing, deleting)

Timeouts used:
JTextComponentOperator.PushKeyTimeout - time between key pressing and releasing during text typing
JTextComponentOperator.BetweenKeysTimeout - time to sleep between two chars typing
JTextComponentOperator.ChangeCaretPositionTimeout - maximum time to chenge caret position
JTextComponentOperator.TypeTextTimeout - maximum time to type text
ComponentOperator.WaitComponentTimeout - time to wait component displayed
ComponentOperator.WaitFocusTimeout - time to wait component focus
ComponentOperator.WaitStateTimeout - time to wait for text
JScrollBarOperator.OneScrollClickTimeout - time for one scroll click
JScrollBarOperator.WholeScrollTimeout - time for the whole scrolling
.
Author:
Alexandre Iline (alexandre.iline@sun.com)
See Also:

  • Field Details

    • TEXT_DPROP

      public static final String TEXT_DPROP
      Identifier for a "text" property.
      See Also:

    • SELECTED_TEXT_DPROP

      public static final String SELECTED_TEXT_DPROP
      Identifier for a "selected text" property.
      See Also:

    • IS_EDITABLE_DPROP

      public static final String IS_EDITABLE_DPROP
      Identifier for a "editable" property.
      See Also:

    • modifiersPressed

      protected int modifiersPressed
      Deprecated.
      All text operations are performed by TextDriver regitered for this operator type.
      Notifies what modifiers are pressed.

  • Constructor Details

    • JTextComponentOperator

      public JTextComponentOperator(JTextComponent b)
      Constructor.
      Parameters:
      b - Component to operate with.

    • JTextComponentOperator

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

    • JTextComponentOperator

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

    • JTextComponentOperator

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

    • JTextComponentOperator

      public JTextComponentOperator(ContainerOperator cont, String text)
      Constructor. Waits component in container first. Uses cont's timeout and output for waiting and to init operator.
      Parameters:
      cont - a container
      text - Button text.
      Throws:
      TimeoutExpiredException
      See Also:

    • JTextComponentOperator

      public JTextComponentOperator(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

    • JTextComponentOperator

      public JTextComponentOperator(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 Details

    • findJTextComponent

      public static JTextComponent findJTextComponent(Container cont, ComponentChooser chooser, int index)
      Searches JTextComponent in container.
      Parameters:
      cont - Container to search component in.
      chooser - a component chooser specifying searching criteria.
      index - Ordinal component index.
      Returns:
      JTextComponent instance or null if component was not found.

    • findJTextComponent

      public static JTextComponent findJTextComponent(Container cont, ComponentChooser chooser)
      Searches JTextComponent in container.
      Parameters:
      cont - Container to search component in.
      chooser - a component chooser specifying searching criteria.
      Returns:
      JTextComponent instance or null if component was not found.

    • findJTextComponent

      public static JTextComponent findJTextComponent(Container cont, String text, boolean ce, boolean ccs, int index)
      Searches JTextComponent by text.
      Parameters:
      cont - Container to search component in.
      text - Component text.
      ce - Compare text exactly.
      ccs - Compare text case sensitively.
      index - Ordinal component index.
      Returns:
      JTextComponent instance or null if component was not found.
      See Also:

    • findJTextComponent

      public static JTextComponent findJTextComponent(Container cont, String text, boolean ce, boolean ccs)
      Searches JTextComponent by text.
      Parameters:
      cont - Container to search component in.
      text - Component text.
      ce - Compare text exactly.
      ccs - Compare text case sensitively.
      Returns:
      JTextComponent instance or null if component was not found.
      See Also:

    • waitJTextComponent

      public static JTextComponent waitJTextComponent(Container cont, ComponentChooser chooser, int index)
      Waits JTextComponent in container.
      Parameters:
      cont - Container to search component in.
      chooser - a component chooser specifying searching criteria.
      index - Ordinal component index.
      Returns:
      JTextComponent instance.
      Throws:
      TimeoutExpiredException

    • waitJTextComponent

      public static JTextComponent waitJTextComponent(Container cont, ComponentChooser chooser)
      Waits JTextComponent in container.
      Parameters:
      cont - Container to search component in.
      chooser - a component chooser specifying searching criteria.
      Returns:
      JTextComponent instance.
      Throws:
      TimeoutExpiredException

    • waitJTextComponent

      public static JTextComponent waitJTextComponent(Container cont, String text, boolean ce, boolean ccs, int index)
      Waits JTextComponent by text.
      Parameters:
      cont - Container to search component in.
      text - Component text.
      ce - Compare text exactly.
      ccs - Compare text case sensitively.
      index - Ordinal component index.
      Returns:
      JTextComponent instance.
      Throws:
      TimeoutExpiredException
      See Also:

    • waitJTextComponent

      public static JTextComponent waitJTextComponent(Container cont, String text, boolean ce, boolean ccs)
      Waits JTextComponent by text.
      Parameters:
      cont - Container to search component in.
      text - Component text.
      ce - Compare text exactly.
      ccs - Compare text case sensitively.
      Returns:
      JTextComponent instance.
      Throws:
      TimeoutExpiredException
      See Also:

    • setTimeouts

      public void setTimeouts(Timeouts times)
      Description copied from interface: Timeoutable
      Defines current timeouts.
      Specified by:
      setTimeouts in interface Timeoutable
      Overrides:
      setTimeouts in class JComponentOperator
      Parameters:
      times - A collection of timeout assignments.
      See Also:

    • getTimeouts

      public Timeouts getTimeouts()
      Description copied from interface: Timeoutable
      Return current timeouts.
      Specified by:
      getTimeouts in interface Timeoutable
      Overrides:
      getTimeouts in class JComponentOperator
      Returns:
      the collection of current timeout assignments.
      See Also:

    • setOutput

      public void setOutput(TestOut out)
      Description copied from class: ComponentOperator
      /////////////////////////////////////////////////////
      Specified by:
      setOutput in interface Outputable
      Overrides:
      setOutput in class JComponentOperator
      Parameters:
      out - Identify the streams or writers used for print output.
      See Also:

    • getOutput

      public TestOut getOutput()
      Description copied from interface: Outputable
      Returns print output streams or writers.
      Specified by:
      getOutput in interface Outputable
      Overrides:
      getOutput in class JComponentOperator
      Returns:
      an object that contains references to objects for printing to output and err streams.
      See Also:

    • 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.

    • getPositionByText

      public int getPositionByText(String text, JTextComponentOperator.TextChooser tChooser, int index)
      Finds start text position.
      Parameters:
      text - Text to be searched.
      tChooser - Additional search criteria.
      index - Index of text instance (first instance has index 0)
      Returns:
      Caret position correspondent to text start.
      See Also:

    • getPositionByText

      public int getPositionByText(String text, JTextComponentOperator.TextChooser tChooser)
      Finds start text position.
      Parameters:
      text - Text to be searched.
      tChooser - Additional search criteria.
      Returns:
      Caret position correspondent to text start.

    • getPositionByText

      public int getPositionByText(String text, int index)
      Finds start text position.
      Parameters:
      text - Text to be searched.
      index - Index of text instance (first instance has index 0)
      Returns:
      Caret position correspondent to text start.

    • getPositionByText

      public int getPositionByText(String text)
      Finds start text position.
      Parameters:
      text - Text to be searched.
      Returns:
      Caret position correspondent to text start.

    • enterText

      public void enterText(String text)
      Requests a focus, clears text, types new one and pushes Enter.
      Parameters:
      text - New text value. Shouln't include final '\n'.
      Throws:
      TimeoutExpiredException

    • changeCaretPosition

      public void changeCaretPosition(int position)
      Changes caret position.
      Parameters:
      position - Position to move caret to.
      Throws:
      TimeoutExpiredException
      See Also:

    • changeCaretPosition

      public void changeCaretPosition(String text, int index, boolean before)
      Puts caret before or after text.
      Parameters:
      text - Text to be searched.
      index - Index of text instance (first instance has index 0)
      before - If true put caret before text, otherwise after.
      Throws:
      TimeoutExpiredException
      JTextComponentOperator.NoSuchTextException
      See Also:

    • changeCaretPosition

      public void changeCaretPosition(String text, boolean before)
      Puts caret before or after text.
      Parameters:
      text - Text to be searched.
      before - If true put caret before text, otherwise after.
      Throws:
      TimeoutExpiredException
      JTextComponentOperator.NoSuchTextException
      See Also:

    • typeText

      public void typeText(String text, int caretPosition)
      Types text starting from known position. If verification mode is on, checks that right text has been typed and caret has been moved to right position.
      Parameters:
      text - Text to be typed.
      caretPosition - Position to start type text
      Throws:
      TimeoutExpiredException
      JTextComponentOperator.NoSuchTextException
      See Also:

    • typeText

      public void typeText(String text)
      Types text starting from the current position.
      Parameters:
      text - Text to be typed.
      Throws:
      TimeoutExpiredException
      See Also:

    • selectText

      public void selectText(int startPosition, int finalPosition)
      Selects a part of text.
      Parameters:
      startPosition - Start caret position
      finalPosition - Final caret position
      Throws:
      TimeoutExpiredException
      See Also:

    • selectText

      public void selectText(String text, int index)
      Selects a part of text.
      Parameters:
      text - Text to be selected
      index - Index of text instance (first instance has index 0)
      Throws:
      TimeoutExpiredException
      JTextComponentOperator.NoSuchTextException
      See Also:

    • selectText

      public void selectText(String text)
      Selects a part of text.
      Parameters:
      text - Text to be selected
      Throws:
      TimeoutExpiredException
      JTextComponentOperator.NoSuchTextException
      See Also:

    • clearText

      public void clearText()
      Clears text.
      Throws:
      TimeoutExpiredException

    • scrollToPosition

      public void scrollToPosition(int position)
      Scrolls to a text poistion.
      Parameters:
      position - a position to scroll.
      Throws:
      TimeoutExpiredException

    • getDisplayedText

      public String getDisplayedText()
      Returns text which is really displayed. Results returned by getText() and getDisplayedText() are different if text component is used to display javax.swing.text.StyledDocument
      Returns:
      the text which is displayed.

    • waitText

      public void waitText(String text, int position)
      Wait for text to be displayed starting from certain position.
      Parameters:
      text - text to wait.
      position - starting text position.

    • waitText

      public void waitText(String text)
      Waits for certain text.
      Parameters:
      text - Text to be compared by getComparator() comparator.

    • waitCaretPosition

      public void waitCaretPosition(int position)
      Wait for caret to be moved to certain position.
      Parameters:
      position - a position which caret supposed to be moved to.

    • getDump

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

    • addCaretListener

      public void addCaretListener(CaretListener caretListener)
      Maps JTextComponent.addCaretListener(CaretListener) through queue

    • copy

      public void copy()
      Maps JTextComponent.copy() through queue

    • cut

      public void cut()
      Maps JTextComponent.cut() through queue

    • getActions

      public Action[] getActions()
      Maps JTextComponent.getActions() through queue

    • getCaret

      public Caret getCaret()
      Maps JTextComponent.getCaret() through queue

    • getCaretColor

      public Color getCaretColor()
      Maps JTextComponent.getCaretColor() through queue

    • getCaretPosition

      public int getCaretPosition()
      Maps JTextComponent.getCaretPosition() through queue

    • getDisabledTextColor

      public Color getDisabledTextColor()
      Maps JTextComponent.getDisabledTextColor() through queue

    • getDocument

      public Document getDocument()
      Maps JTextComponent.getDocument() through queue

    • getFocusAccelerator

      public char getFocusAccelerator()
      Maps JTextComponent.getFocusAccelerator() through queue

    • getHighlighter

      public Highlighter getHighlighter()
      Maps JTextComponent.getHighlighter() through queue

    • getKeymap

      public Keymap getKeymap()
      Maps JTextComponent.getKeymap() through queue

    • getMargin

      public Insets getMargin()
      Maps JTextComponent.getMargin() through queue

    • getPreferredScrollableViewportSize

      public Dimension getPreferredScrollableViewportSize()
      Maps JTextComponent.getPreferredScrollableViewportSize() through queue

    • getScrollableBlockIncrement

      public int getScrollableBlockIncrement(Rectangle rectangle, int i, int i1)
      Maps JTextComponent.getScrollableBlockIncrement(Rectangle, int, int) through queue

    • getScrollableTracksViewportHeight

      public boolean getScrollableTracksViewportHeight()
      Maps JTextComponent.getScrollableTracksViewportHeight() through queue

    • getScrollableTracksViewportWidth

      public boolean getScrollableTracksViewportWidth()
      Maps JTextComponent.getScrollableTracksViewportWidth() through queue

    • getScrollableUnitIncrement

      public int getScrollableUnitIncrement(Rectangle rectangle, int i, int i1)
      Maps JTextComponent.getScrollableUnitIncrement(Rectangle, int, int) through queue

    • getSelectedText

      public String getSelectedText()
      Maps JTextComponent.getSelectedText() through queue

    • getSelectedTextColor

      public Color getSelectedTextColor()
      Maps JTextComponent.getSelectedTextColor() through queue

    • getSelectionColor

      public Color getSelectionColor()
      Maps JTextComponent.getSelectionColor() through queue

    • getSelectionEnd

      public int getSelectionEnd()
      Maps JTextComponent.getSelectionEnd() through queue

    • getSelectionStart

      public int getSelectionStart()
      Maps JTextComponent.getSelectionStart() through queue

    • getText

      public String getText()
      Maps JTextComponent.getText() through queue

    • getText

      public String getText(int i, int i1)
      Maps JTextComponent.getText(int, int) through queue

    • getUI

      public TextUI getUI()
      Maps JTextComponent.getUI() through queue

    • isEditable

      public boolean isEditable()
      Maps JTextComponent.isEditable() through queue

    • modelToView

      public Rectangle modelToView(int i)
      Maps JTextComponent.modelToView(int) through queue

    • moveCaretPosition

      public void moveCaretPosition(int i)
      Maps JTextComponent.moveCaretPosition(int) through queue

    • paste

      public void paste()
      Maps JTextComponent.paste() through queue

    • read

      public void read(Reader reader, Object object)
      Maps JTextComponent.read(Reader, Object) through queue

    • removeCaretListener

      public void removeCaretListener(CaretListener caretListener)
      Maps JTextComponent.removeCaretListener(CaretListener) through queue

    • replaceSelection

      public void replaceSelection(String string)
      Maps JTextComponent.replaceSelection(String) through queue

    • select

      public void select(int i, int i1)
      Maps JTextComponent.select(int, int) through queue

    • selectAll

      public void selectAll()
      Maps JTextComponent.selectAll() through queue

    • setCaret

      public void setCaret(Caret caret)
      Maps JTextComponent.setCaret(Caret) through queue

    • setCaretColor

      public void setCaretColor(Color color)
      Maps JTextComponent.setCaretColor(Color) through queue

    • setCaretPosition

      public void setCaretPosition(int i)
      Maps JTextComponent.setCaretPosition(int) through queue

    • setDisabledTextColor

      public void setDisabledTextColor(Color color)
      Maps JTextComponent.setDisabledTextColor(Color) through queue

    • setDocument

      public void setDocument(Document document)
      Maps JTextComponent.setDocument(Document) through queue

    • setEditable

      public void setEditable(boolean b)
      Maps JTextComponent.setEditable(boolean) through queue

    • setFocusAccelerator

      public void setFocusAccelerator(char c)
      Maps JTextComponent.setFocusAccelerator(char) through queue

    • setHighlighter

      public void setHighlighter(Highlighter highlighter)
      Maps JTextComponent.setHighlighter(Highlighter) through queue

    • setKeymap

      public void setKeymap(Keymap keymap)
      Maps JTextComponent.setKeymap(Keymap) through queue

    • setMargin

      public void setMargin(Insets insets)
      Maps JTextComponent.setMargin(Insets) through queue

    • setSelectedTextColor

      public void setSelectedTextColor(Color color)
      Maps JTextComponent.setSelectedTextColor(Color) through queue

    • setSelectionColor

      public void setSelectionColor(Color color)
      Maps JTextComponent.setSelectionColor(Color) through queue

    • setSelectionEnd

      public void setSelectionEnd(int i)
      Maps JTextComponent.setSelectionEnd(int) through queue

    • setSelectionStart

      public void setSelectionStart(int i)
      Maps JTextComponent.setSelectionStart(int) through queue

    • setText

      public void setText(String string)
      Maps JTextComponent.setText(String) through queue

    • setUI

      public void setUI(TextUI textUI)
      Maps JTextComponent.setUI(TextUI) through queue

    • viewToModel

      public int viewToModel(Point point)
      Maps JTextComponent.viewToModel(Point) through queue

    • write

      public void write(Writer writer)
      Maps JTextComponent.write(Writer) through queue