/*
* Copyright (c) 1997, 2016, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
package org.netbeans.jemmy.operators;
import java.awt.Component;
import java.awt.Container;
import javax.swing.Icon;
import javax.swing.JTextPane;
import javax.swing.text.AttributeSet;
import javax.swing.text.MutableAttributeSet;
import javax.swing.text.Style;
import javax.swing.text.StyledDocument;
import org.netbeans.jemmy.ComponentChooser;
/**
* <BR><BR>Timeouts used: <BR>
* JTextComponentOperator.PushKeyTimeout - time between key pressing and
* releasing during text typing <BR>
* JTextComponentOperator.BetweenKeysTimeout - time to sleep between two chars
* typing <BR>
* JTextComponentOperator.ChangeCaretPositionTimeout - maximum time to chenge
* caret position <BR>
* JTextComponentOperator.TypeTextTimeout - maximum time to type text <BR>
* ComponentOperator.WaitComponentTimeout - time to wait component displayed
* <BR>
* ComponentOperator.WaitFocusTimeout - time to wait component focus <BR>
* JScrollBarOperator.OneScrollClickTimeout - time for one scroll click <BR>
* JScrollBarOperator.WholeScrollTimeout - time for the whole scrolling <BR>.
*
* @see org.netbeans.jemmy.Timeouts
*
* @author Alexandre Iline (alexandre.iline@oracle.com)
*
*/
public class JTextPaneOperator extends JEditorPaneOperator {
/**
* Constructor.
*
* @param b a component
*/
public JTextPaneOperator(JTextPane b) {
super(b);
}
/**
* Constructs a JTextPaneOperator object.
*
* @param cont a container
* @param chooser a component chooser specifying searching criteria.
* @param index an index between appropriate ones.
*/
public JTextPaneOperator(ContainerOperator<?> cont, ComponentChooser chooser, int index) {
this((JTextPane) cont.
waitSubComponent(new JTextPaneFinder(chooser),
index));
copyEnvironment(cont);
}
/**
* Constructs a JTextPaneOperator object.
*
* @param cont a container
* @param chooser a component chooser specifying searching criteria.
*/
public JTextPaneOperator(ContainerOperator<?> cont, ComponentChooser chooser) {
this(cont, chooser, 0);
}
/**
* Constructor. Waits component in container first. Uses cont's timeout and
* output for waiting and to init operator.
*
* @param cont a container
* @param text Button text.
* @param index Ordinal component index.
* @see ComponentOperator#isCaptionEqual(String, String, boolean, boolean)
*/
public JTextPaneOperator(ContainerOperator<?> cont, String text, int index) {
this((JTextPane) waitComponent(cont,
new JTextPaneFinder(new JTextComponentOperator.JTextComponentByTextFinder(text,
cont.getComparator())),
index));
copyEnvironment(cont);
}
/**
* Constructor. Waits component in container first. Uses cont's timeout and
* output for waiting and to init operator.
*
* @param cont a container
* @param text Button text.
* @see ComponentOperator#isCaptionEqual(String, String, boolean, boolean)
*/
public JTextPaneOperator(ContainerOperator<?> cont, String text) {
this(cont, text, 0);
}
/**
* Constructor. Waits component in container first. Uses cont's timeout and
* output for waiting and to init operator.
*
* @param cont a container
* @param index Ordinal component index.
*/
public JTextPaneOperator(ContainerOperator<?> cont, int index) {
this((JTextPane) waitComponent(cont,
new JTextPaneFinder(),
index));
copyEnvironment(cont);
}
/**
* Constructor. Waits component in container first. Uses cont's timeout and
* output for waiting and to init operator.
*
* @param cont a container
*/
public JTextPaneOperator(ContainerOperator<?> cont) {
this(cont, 0);
}
/**
* Searches JTextPane in container.
*
* @param cont Container to search component in.
* @param chooser a component chooser specifying searching criteria.
* @param index Ordinal component index.
* @return JTextPane instance or null if component was not found.
*/
public static JTextPane findJTextPane(Container cont, ComponentChooser chooser, int index) {
return (JTextPane) findJTextComponent(cont, new JTextPaneFinder(chooser), index);
}
/**
* Searches JTextPane in container.
*
* @param cont Container to search component in.
* @param chooser a component chooser specifying searching criteria.
* @return JTextPane instance or null if component was not found.
*/
public static JTextPane findJTextPane(Container cont, ComponentChooser chooser) {
return findJTextPane(cont, chooser, 0);
}
/**
* Searches JTextPane by text.
*
* @param cont Container to search component in.
* @param text Component text.
* @param ce Compare text exactly.
* @param ccs Compare text case sensitively.
* @param index Ordinal component index.
* @return JTextPane instance or null if component was not found.
* @see ComponentOperator#isCaptionEqual(String, String, boolean, boolean)
*/
public static JTextPane findJTextPane(Container cont, String text, boolean ce, boolean ccs, int index) {
return (findJTextPane(cont,
new JTextPaneFinder(new JTextComponentOperator.JTextComponentByTextFinder(text,
new DefaultStringComparator(ce, ccs))),
index));
}
/**
* Searches JTextPane by text.
*
* @param cont Container to search component in.
* @param text Component text.
* @param ce Compare text exactly.
* @param ccs Compare text case sensitively.
* @return JTextPane instance or null if component was not found.
* @see ComponentOperator#isCaptionEqual(String, String, boolean, boolean)
*/
public static JTextPane findJTextPane(Container cont, String text, boolean ce, boolean ccs) {
return findJTextPane(cont, text, ce, ccs, 0);
}
/**
* Waits JTextPane in container.
*
* @param cont Container to search component in.
* @param chooser a component chooser specifying searching criteria.
* @param index Ordinal component index.
* @return JTextPane instance.
*/
public static JTextPane waitJTextPane(Container cont, ComponentChooser chooser, int index) {
return (JTextPane) waitJTextComponent(cont, new JTextPaneFinder(chooser), index);
}
/**
* Waits JTextPane in container.
*
* @param cont Container to search component in.
* @param chooser a component chooser specifying searching criteria.
* @return JTextPane instance.
*/
public static JTextPane waitJTextPane(Container cont, ComponentChooser chooser) {
return waitJTextPane(cont, chooser, 0);
}
/**
* Waits JTextPane by text.
*
* @param cont Container to search component in.
* @param text Component text.
* @param ce Compare text exactly.
* @param ccs Compare text case sensitively.
* @param index Ordinal component index.
* @return JTextPane instance.
* @see ComponentOperator#isCaptionEqual(String, String, boolean, boolean)
*/
public static JTextPane waitJTextPane(Container cont, String text, boolean ce, boolean ccs, int index) {
return (waitJTextPane(cont,
new JTextPaneFinder(new JTextComponentOperator.JTextComponentByTextFinder(text,
new DefaultStringComparator(ce, ccs))),
index));
}
/**
* Waits JTextPane by text.
*
* @param cont Container to search component in.
* @param text Component text.
* @param ce Compare text exactly.
* @param ccs Compare text case sensitively.
* @return JTextPane instance.
* @see ComponentOperator#isCaptionEqual(String, String, boolean, boolean)
*/
public static JTextPane waitJTextPane(Container cont, String text, boolean ce, boolean ccs) {
return waitJTextPane(cont, text, ce, ccs, 0);
}
////////////////////////////////////////////////////////
//Mapping //
/**
* Maps {@code JTextPane.addStyle(String, Style)} through queue
*/
public Style addStyle(final String string, final Style style) {
return (runMapping(new MapAction<Style>("addStyle") {
@Override
public Style map() {
return ((JTextPane) getSource()).addStyle(string, style);
}
}));
}
/**
* Maps {@code JTextPane.getCharacterAttributes()} through queue
*/
public AttributeSet getCharacterAttributes() {
return (runMapping(new MapAction<AttributeSet>("getCharacterAttributes") {
@Override
public AttributeSet map() {
return ((JTextPane) getSource()).getCharacterAttributes();
}
}));
}
/**
* Maps {@code JTextPane.getInputAttributes()} through queue
*/
public MutableAttributeSet getInputAttributes() {
return (runMapping(new MapAction<MutableAttributeSet>("getInputAttributes") {
@Override
public MutableAttributeSet map() {
return ((JTextPane) getSource()).getInputAttributes();
}
}));
}
/**
* Maps {@code JTextPane.getLogicalStyle()} through queue
*/
public Style getLogicalStyle() {
return (runMapping(new MapAction<Style>("getLogicalStyle") {
@Override
public Style map() {
return ((JTextPane) getSource()).getLogicalStyle();
}
}));
}
/**
* Maps {@code JTextPane.getParagraphAttributes()} through queue
*/
public AttributeSet getParagraphAttributes() {
return (runMapping(new MapAction<AttributeSet>("getParagraphAttributes") {
@Override
public AttributeSet map() {
return ((JTextPane) getSource()).getParagraphAttributes();
}
}));
}
/**
* Maps {@code JTextPane.getStyle(String)} through queue
*/
public Style getStyle(final String string) {
return (runMapping(new MapAction<Style>("getStyle") {
@Override
public Style map() {
return ((JTextPane) getSource()).getStyle(string);
}
}));
}
/**
* Maps {@code JTextPane.getStyledDocument()} through queue
*/
public StyledDocument getStyledDocument() {
return (runMapping(new MapAction<StyledDocument>("getStyledDocument") {
@Override
public StyledDocument map() {
return ((JTextPane) getSource()).getStyledDocument();
}
}));
}
/**
* Maps {@code JTextPane.insertComponent(Component)} through queue
*/
public void insertComponent(final Component component) {
runMapping(new MapVoidAction("insertComponent") {
@Override
public void map() {
((JTextPane) getSource()).insertComponent(component);
}
});
}
/**
* Maps {@code JTextPane.insertIcon(Icon)} through queue
*/
public void insertIcon(final Icon icon) {
runMapping(new MapVoidAction("insertIcon") {
@Override
public void map() {
((JTextPane) getSource()).insertIcon(icon);
}
});
}
/**
* Maps {@code JTextPane.removeStyle(String)} through queue
*/
public void removeStyle(final String string) {
runMapping(new MapVoidAction("removeStyle") {
@Override
public void map() {
((JTextPane) getSource()).removeStyle(string);
}
});
}
/**
* Maps {@code JTextPane.setCharacterAttributes(AttributeSet, boolean)}
* through queue
*/
public void setCharacterAttributes(final AttributeSet attributeSet, final boolean b) {
runMapping(new MapVoidAction("setCharacterAttributes") {
@Override
public void map() {
((JTextPane) getSource()).setCharacterAttributes(attributeSet, b);
}
});
}
/**
* Maps {@code JTextPane.setLogicalStyle(Style)} through queue
*/
public void setLogicalStyle(final Style style) {
runMapping(new MapVoidAction("setLogicalStyle") {
@Override
public void map() {
((JTextPane) getSource()).setLogicalStyle(style);
}
});
}
/**
* Maps {@code JTextPane.setParagraphAttributes(AttributeSet, boolean)}
* through queue
*/
public void setParagraphAttributes(final AttributeSet attributeSet, final boolean b) {
runMapping(new MapVoidAction("setParagraphAttributes") {
@Override
public void map() {
((JTextPane) getSource()).setParagraphAttributes(attributeSet, b);
}
});
}
/**
* Maps {@code JTextPane.setStyledDocument(StyledDocument)} through queue
*/
public void setStyledDocument(final StyledDocument styledDocument) {
runMapping(new MapVoidAction("setStyledDocument") {
@Override
public void map() {
((JTextPane) getSource()).setStyledDocument(styledDocument);
}
});
}
//End of mapping //
////////////////////////////////////////////////////////
/**
* Checks component type.
*/
public static class JTextPaneFinder extends Finder {
/**
* Constructs JTextPaneFinder.
*
* @param sf other searching criteria.
*/
public JTextPaneFinder(ComponentChooser sf) {
super(JTextPane.class, sf);
}
/**
* Constructs JTextPaneFinder.
*/
public JTextPaneFinder() {
super(JTextPane.class);
}
}
}