/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common
* Development and Distribution License("CDDL") (collectively, the
* "License"). You may not use this file except in compliance with the
* License. You can obtain a copy of the License at
* http://www.netbeans.org/cddl-gplv2.html
* or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
* specific language governing permissions and limitations under the
* License. When distributing the software, include this License Header
* Notice in each file and include the License file at
* nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
* particular file as subject to the "Classpath" exception as provided
* by Sun in the GPL Version 2 section of the License file that
* accompanied this code. If applicable, add the following below the
* License Header, with the fields enclosed by brackets [] replaced by
* your own identifying information:
* "Portions Copyrighted [year] [name of copyright owner]"
*
* Contributor(s): Alexandre Iline.
*
* The Original Software is the Jemmy library.
* The Initial Developer of the Original Software is Alexandre Iline.
* All Rights Reserved.
*
* If you wish your version of this file to be governed by only the CDDL
* or only the GPL Version 2, indicate your decision by adding
* "[Contributor] elects to include this software in this distribution
* under the [CDDL or GPL Version 2] license." If you do not indicate a
* single choice of license, a recipient has the option to distribute
* your version of this file under either the CDDL, the GPL Version 2 or
* to extend the choice of license to its licensees as provided above.
* However, if you add GPL Version 2 code and therefore, elected the GPL
* Version 2 license, then the option applies only if the new code is
* made subject to such option by the copyright holder.
*
*
*
* $Id$ $Revision$ $Date$
*
*/
package org.netbeans.jemmy.operators;
import java.awt.Component;
import java.awt.Container;
import java.util.Hashtable;
import javax.swing.JButton;
import javax.swing.JSplitPane;
import javax.swing.plaf.SplitPaneUI;
import javax.swing.plaf.basic.BasicSplitPaneDivider;
import org.netbeans.jemmy.Action;
import org.netbeans.jemmy.ComponentChooser;
import org.netbeans.jemmy.ComponentSearcher;
import org.netbeans.jemmy.Outputable;
import org.netbeans.jemmy.TestOut;
import org.netbeans.jemmy.TimeoutExpiredException;
import org.netbeans.jemmy.Timeoutable;
import org.netbeans.jemmy.Timeouts;
import org.netbeans.jemmy.drivers.DriverManager;
import org.netbeans.jemmy.drivers.ScrollDriver;
import org.netbeans.jemmy.drivers.scrolling.ScrollAdjuster;
import org.netbeans.jemmy.util.EmptyVisualizer;
/**
* <BR><BR>Timeouts used: <BR>
* JSplitPaneOperator.ScrollClickTimeout - time for simple scroll click <BR>
* JSplitPaneOperator.BetweenClickTimeout - time to sleep between scroll clicks <BR>
* JSplitPaneOperator.WholeScrollTimeout - time for the whole scrolling <BR>
* ComponentOperator.WaitComponentTimeout - time to wait component displayed <BR>.
*
* @see org.netbeans.jemmy.Timeouts
*
* @author Alexandre Iline (alexandre.iline@sun.com)
*
* Class to operate with javax.swing.JSplitPane component
*
*/
public class JSplitPaneOperator extends JComponentOperator
implements Timeoutable, Outputable{
/**
* Identifier for a "minimum" property.
* @see #getDump
*/
public static final String MINIMUM_DPROP = "Minimum";
/**
* Identifier for a "maximum" property.
* @see #getDump
*/
public static final String MAXIMUM_DPROP = "Maximum";
/**
* Identifier for a "value" property.
* @see #getDump
*/
public static final String VALUE_DPROP = "Value";
/**
* Identifier for a "orientation" property.
* @see #getDump
*/
public static final String ORIENTATION_DPROP = "Orientation";
/**
* Identifier for a "HORIZONTAL" value of "orientation" property.
* @see #getDump
*/
public static final String HORIZONTAL_ORIENTATION_DPROP_VALUE = "HORIZONTAL";
/**
* Identifier for a "VERTICAL" value of "orientation" property.
* @see #getDump
*/
public static final String VERTICAL_ORIENTATION_DPROP_VALUE = "VERTICAL";
/**
* Identifier for a "one touch expendable" property.
* @see #getDump
*/
public static final String IS_ONE_TOUCH_EXPANDABLE_DPROP = "One touch expandable";
private final static long SCROLL_CLICK_TIMEOUT = 0;
private final static long BETWEEN_CLICK_TIMEOUT = 0;
private final static long WHOLE_SCROLL_TIMEOUT = 60000;
private Timeouts timeouts;
private TestOut output;
private ContainerOperator divider;
private ScrollDriver driver;
/**
* Constructor.
* @param b JSplitPane component.
*/
public JSplitPaneOperator(JSplitPane b) {
super(b);
driver = DriverManager.getScrollDriver(getClass());
}
/**
* Constructs a JSplitPaneOperator object.
* @param cont a container
* @param chooser a component chooser specifying searching criteria.
* @param index an index between appropriate ones.
*/
public JSplitPaneOperator(ContainerOperator cont, ComponentChooser chooser, int index) {
this((JSplitPane)cont.
waitSubComponent(new JSplitPaneFinder(chooser),
index));
copyEnvironment(cont);
}
/**
* Constructs a JSplitPaneOperator object.
* @param cont a container
* @param chooser a component chooser specifying searching criteria.
*/
public JSplitPaneOperator(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 Operator pointing a container to search component in.
* @param index Ordinal component index.
* @throws TimeoutExpiredException
*/
public JSplitPaneOperator(ContainerOperator cont, int index) {
this((JSplitPane)waitComponent(cont,
new JSplitPaneFinder(),
index));
copyEnvironment(cont);
}
/**
* Constructor.
* Waits component in container first.
* Uses cont's timeout and output for waiting and to init operator.
* @param cont Operator pointing a container to search component in.
* @throws TimeoutExpiredException
*/
public JSplitPaneOperator(ContainerOperator cont) {
this(cont, 0);
}
/**
* Searches JSplitPane in container.
* @param cont Container to search component in.
* @param chooser org.netbeans.jemmy.ComponentChooser implementation.
* @param index Ordinal component index.
* @return JSplitPane instance or null if component was not found.
*/
public static JSplitPane findJSplitPane(Container cont, ComponentChooser chooser, int index) {
return((JSplitPane)findComponent(cont, new JSplitPaneFinder(chooser), index));
}
/**
* Searches 0'th JSplitPane in container.
* @param cont Container to search component in.
* @param chooser org.netbeans.jemmy.ComponentChooser implementation.
* @return JSplitPane instance or null if component was not found.
*/
public static JSplitPane findJSplitPane(Container cont, ComponentChooser chooser) {
return(findJSplitPane(cont, chooser, 0));
}
/**
* Searches JSplitPane in container.
* @param cont Container to search component in.
* @param index Ordinal component index.
* @return JSplitPane instance or null if component was not found.
*/
public static JSplitPane findJSplitPane(Container cont, int index) {
return(findJSplitPane(cont, ComponentSearcher.getTrueChooser(Integer.toString(index) + "'th JSplitPane instance"), index));
}
/**
* Searches 0'th JSplitPane in container.
* @param cont Container to search component in.
* @return JSplitPane instance or null if component was not found.
*/
public static JSplitPane findJSplitPane(Container cont) {
return(findJSplitPane(cont, 0));
}
/**
* Searches JSplitPane object which component lies on.
* @param comp Component to find JSplitPane under.
* @param chooser org.netbeans.jemmy.ComponentChooser implementation.
* @return JSplitPane instance or null if component was not found.
*/
public static JSplitPane findJSplitPaneUnder(Component comp, ComponentChooser chooser) {
return((JSplitPane)findContainerUnder(comp, new JSplitPaneFinder(chooser)));
}
/**
* Searches JSplitPane object which component lies on.
* @param comp Component to find JSplitPane under.
* @return JSplitPane instance or null if component was not found.
*/
public static JSplitPane findJSplitPaneUnder(Component comp) {
return(findJSplitPaneUnder(comp, new JSplitPaneFinder()));
}
/**
* Waits JSplitPane in container.
* @param cont Container to search component in.
* @param chooser org.netbeans.jemmy.ComponentChooser implementation.
* @param index Ordinal component index.
* @return JSplitPane instance or null if component was not displayed.
* @throws TimeoutExpiredException
*/
public static JSplitPane waitJSplitPane(Container cont, ComponentChooser chooser, int index) {
return((JSplitPane)waitComponent(cont, new JSplitPaneFinder(chooser), index));
}
/**
* Waits 0'th JSplitPane in container.
* @param cont Container to search component in.
* @param chooser org.netbeans.jemmy.ComponentChooser implementation.
* @return JSplitPane instance or null if component was not displayed.
* @throws TimeoutExpiredException
*/
public static JSplitPane waitJSplitPane(Container cont, ComponentChooser chooser) {
return(waitJSplitPane(cont, chooser, 0));
}
/**
* Waits JSplitPane in container.
* @param cont Container to search component in.
* @param index Ordinal component index.
* @return JSplitPane instance or null if component was not displayed.
* @throws TimeoutExpiredException
*/
public static JSplitPane waitJSplitPane(Container cont, int index) {
return(waitJSplitPane(cont, ComponentSearcher.getTrueChooser(Integer.toString(index) + "'th JSplitPane instance"), index));
}
/**
* Waits 0'th JSplitPane in container.
* @param cont Container to search component in.
* @return JSplitPane instance or null if component was not displayed.
* @throws TimeoutExpiredException
*/
public static JSplitPane waitJSplitPane(Container cont) {
return(waitJSplitPane(cont, 0));
}
static {
Timeouts.initDefault("JSplitPaneOperator.ScrollClickTimeout", SCROLL_CLICK_TIMEOUT);
Timeouts.initDefault("JSplitPaneOperator.BetweenClickTimeout", BETWEEN_CLICK_TIMEOUT);
Timeouts.initDefault("JSplitPaneOperator.WholeScrollTimeout", WHOLE_SCROLL_TIMEOUT);
}
public void setTimeouts(Timeouts timeouts) {
this.timeouts = timeouts;
Timeouts times = timeouts;
times.setTimeout("ComponentOperator.BeforeDragTimeout",
0);
times.setTimeout("ComponentOperator.AfterDragTimeout",
times.getTimeout("JSplitPaneOperator.ScrollClickTimeout"));
super.setTimeouts(times);
}
public Timeouts getTimeouts() {
return(timeouts);
}
public void setOutput(TestOut out) {
output = out;
super.setOutput(output.createErrorOutput());
}
public TestOut getOutput() {
return(output);
}
public void copyEnvironment(Operator anotherOperator) {
super.copyEnvironment(anotherOperator);
driver =
(ScrollDriver)DriverManager.
getDriver(DriverManager.SCROLL_DRIVER_ID,
getClass(),
anotherOperator.getProperties());
}
/**
* Searches divider inside split pane.
* @return an operator for the divider.
*/
public BasicSplitPaneDivider findDivider() {
return((BasicSplitPaneDivider)waitSubComponent(new ComponentChooser() {
public boolean checkComponent(Component comp) {
return(comp instanceof BasicSplitPaneDivider);
}
public String getDescription() {
return("");
}
}));
}
/**
* Searches divider inside split pane.
* @return an operator for the divider.
*/
public ContainerOperator getDivider() {
if(divider == null) {
divider = new ContainerOperator(findDivider());
divider.copyEnvironment(this);
divider.setOutput(getOutput().createErrorOutput());
}
return(divider);
}
/**
* Scrolls to the position defined by a ScrollAdjuster implementation.
* @param adj defines scrolling direction, and so on.
* @throws TimeoutExpiredException
*/
public void scrollTo(final ScrollAdjuster adj) {
produceTimeRestricted(new Action() {
public Object launch(Object obj) {
driver.scroll(JSplitPaneOperator.this, adj);
return(null);
}
public String getDescription() {
return("Moving a divider");
}
}, getTimeouts().getTimeout("JSplitPaneOperator.WholeScrollTimeout"));
}
/**
* Changes divider location.
* @param dividerLocation location to move divider to.
*/
public void moveDivider(int dividerLocation) {
output.printTrace("Move JSplitPane divider to " + Integer.toString(dividerLocation) +
" location. JSplitPane : \n" + toStringSource());
output.printGolden("Move JSplitPane divider to " + Integer.toString(dividerLocation) +
" location");
scrollTo(new ValueScrollAdjuster(dividerLocation));
}
/**
* Changes divider location.
* @param proportionalLocation Proportional location.
* Should be great then 0 and less then 1.
*/
public void moveDivider(double proportionalLocation) {
output.printTrace("Move JSplitPane divider to " + Double.toString(proportionalLocation) +
" proportional location. JSplitPane : \n" + toStringSource());
output.printGolden("Move JSplitPane divider to " + Double.toString(proportionalLocation) +
" proportional location");
scrollTo(new ValueScrollAdjuster(getMinimumDividerLocation() +
(int)(proportionalLocation *
(getMaximumDividerLocation() - getMinimumDividerLocation()))));
}
/**
* Moves the divider all the way to the left/top.
*/
public void moveToMinimum() {
output.printTrace("Scroll JSplitPane to minimum. JSplitPane : \n" + toStringSource());
output.printGolden("Scroll JSplitPane to minimum.");
produceTimeRestricted(new Action() {
public Object launch(Object obj) {
driver.scrollToMinimum(JSplitPaneOperator.this, getOrientation());
return(null);
}
public String getDescription() {
return("Scrolling");
}
}, getTimeouts().getTimeout("JSplitPaneOperator.WholeScrollTimeout"));
}
/**
* Moves the divider all the way to the right/bottom.
*/
public void moveToMaximum() {
output.printTrace("Scroll JSplitPane to maximum. JSplitPane : \n" + toStringSource());
output.printGolden("Scroll JSplitPane to maximum.");
produceTimeRestricted(new Action() {
public Object launch(Object obj) {
driver.scrollToMaximum(JSplitPaneOperator.this, getOrientation());
return(null);
}
public String getDescription() {
return("Scrolling");
}
}, getTimeouts().getTimeout("JSplitPaneOperator.WholeScrollTimeout"));
}
/**
* Pushes one time right(bottom) expand button.
* @throws TimeoutExpiredException
*/
public void expandRight() {
String mess = "Expand ";
if(getOrientation() == JSplitPane.HORIZONTAL_SPLIT) {
mess = mess + "right";
} else {
mess = mess + "bottom";
}
output.printTrace(mess + " JSplitPane side. JSplitPane : \n" + toStringSource());
output.printGolden(mess + " JSplitPane side.");
expandTo(0);
}
/**
* Pushes one time left(top) expand button.
* @throws TimeoutExpiredException
*/
public void expandLeft() {
String mess = "Expand ";
if(getOrientation() == JSplitPane.HORIZONTAL_SPLIT) {
mess = mess + "left";
} else {
mess = mess + "top";
}
output.printTrace(mess + " JSplitPane side. JSplitPane : \n" + toStringSource());
output.printGolden(mess + " JSplitPane side.");
expandTo(1);
}
public Hashtable getDump() {
Hashtable result = super.getDump();
result.put(MINIMUM_DPROP, Integer.toString(((JSplitPane)getSource()).getMinimumDividerLocation()));
result.put(MAXIMUM_DPROP, Integer.toString(((JSplitPane)getSource()).getMaximumDividerLocation()));
result.put(ORIENTATION_DPROP, (((JSplitPane)getSource()).getOrientation() == JSplitPane.HORIZONTAL_SPLIT) ?
HORIZONTAL_ORIENTATION_DPROP_VALUE :
VERTICAL_ORIENTATION_DPROP_VALUE);
result.put(VALUE_DPROP, Integer.toString(((JSplitPane)getSource()).getDividerLocation()));
result.put(IS_ONE_TOUCH_EXPANDABLE_DPROP, ((JSplitPane)getSource()).isOneTouchExpandable() ? "true" : "false");
return(result);
}
////////////////////////////////////////////////////////
//Mapping //
/**Maps <code>JSplitPane.getBottomComponent()</code> through queue*/
public Component getBottomComponent() {
return((Component)runMapping(new MapAction("getBottomComponent") {
public Object map() {
return(((JSplitPane)getSource()).getBottomComponent());
}}));}
/**Maps <code>JSplitPane.getDividerLocation()</code> through queue*/
public int getDividerLocation() {
return(runMapping(new MapIntegerAction("getDividerLocation") {
public int map() {
return(((JSplitPane)getSource()).getDividerLocation());
}}));}
/**Maps <code>JSplitPane.getDividerSize()</code> through queue*/
public int getDividerSize() {
return(runMapping(new MapIntegerAction("getDividerSize") {
public int map() {
return(((JSplitPane)getSource()).getDividerSize());
}}));}
/**Maps <code>JSplitPane.getLastDividerLocation()</code> through queue*/
public int getLastDividerLocation() {
return(runMapping(new MapIntegerAction("getLastDividerLocation") {
public int map() {
return(((JSplitPane)getSource()).getLastDividerLocation());
}}));}
/**Maps <code>JSplitPane.getLeftComponent()</code> through queue*/
public Component getLeftComponent() {
return((Component)runMapping(new MapAction("getLeftComponent") {
public Object map() {
return(((JSplitPane)getSource()).getLeftComponent());
}}));}
/**Maps <code>JSplitPane.getMaximumDividerLocation()</code> through queue*/
public int getMaximumDividerLocation() {
return(runMapping(new MapIntegerAction("getMaximumDividerLocation") {
public int map() {
return(((JSplitPane)getSource()).getMaximumDividerLocation());
}}));}
/**Maps <code>JSplitPane.getMinimumDividerLocation()</code> through queue*/
public int getMinimumDividerLocation() {
return(runMapping(new MapIntegerAction("getMinimumDividerLocation") {
public int map() {
return(((JSplitPane)getSource()).getMinimumDividerLocation());
}}));}
/**Maps <code>JSplitPane.getOrientation()</code> through queue*/
public int getOrientation() {
return(runMapping(new MapIntegerAction("getOrientation") {
public int map() {
return(((JSplitPane)getSource()).getOrientation());
}}));}
/**Maps <code>JSplitPane.getRightComponent()</code> through queue*/
public Component getRightComponent() {
return((Component)runMapping(new MapAction("getRightComponent") {
public Object map() {
return(((JSplitPane)getSource()).getRightComponent());
}}));}
/**Maps <code>JSplitPane.getTopComponent()</code> through queue*/
public Component getTopComponent() {
return((Component)runMapping(new MapAction("getTopComponent") {
public Object map() {
return(((JSplitPane)getSource()).getTopComponent());
}}));}
/**Maps <code>JSplitPane.getUI()</code> through queue*/
public SplitPaneUI getUI() {
return((SplitPaneUI)runMapping(new MapAction("getUI") {
public Object map() {
return(((JSplitPane)getSource()).getUI());
}}));}
/**Maps <code>JSplitPane.isContinuousLayout()</code> through queue*/
public boolean isContinuousLayout() {
return(runMapping(new MapBooleanAction("isContinuousLayout") {
public boolean map() {
return(((JSplitPane)getSource()).isContinuousLayout());
}}));}
/**Maps <code>JSplitPane.isOneTouchExpandable()</code> through queue*/
public boolean isOneTouchExpandable() {
return(runMapping(new MapBooleanAction("isOneTouchExpandable") {
public boolean map() {
return(((JSplitPane)getSource()).isOneTouchExpandable());
}}));}
/**Maps <code>JSplitPane.resetToPreferredSizes()</code> through queue*/
public void resetToPreferredSizes() {
runMapping(new MapVoidAction("resetToPreferredSizes") {
public void map() {
((JSplitPane)getSource()).resetToPreferredSizes();
}});}
/**Maps <code>JSplitPane.setBottomComponent(Component)</code> through queue*/
public void setBottomComponent(final Component component) {
runMapping(new MapVoidAction("setBottomComponent") {
public void map() {
((JSplitPane)getSource()).setBottomComponent(component);
}});}
/**Maps <code>JSplitPane.setContinuousLayout(boolean)</code> through queue*/
public void setContinuousLayout(final boolean b) {
runMapping(new MapVoidAction("setContinuousLayout") {
public void map() {
((JSplitPane)getSource()).setContinuousLayout(b);
}});}
/**Maps <code>JSplitPane.setDividerLocation(double)</code> through queue*/
public void setDividerLocation(final double d) {
runMapping(new MapVoidAction("setDividerLocation") {
public void map() {
((JSplitPane)getSource()).setDividerLocation(d);
}});}
/**Maps <code>JSplitPane.setDividerLocation(int)</code> through queue*/
public void setDividerLocation(final int i) {
runMapping(new MapVoidAction("setDividerLocation") {
public void map() {
((JSplitPane)getSource()).setDividerLocation(i);
}});}
/**Maps <code>JSplitPane.setDividerSize(int)</code> through queue*/
public void setDividerSize(final int i) {
runMapping(new MapVoidAction("setDividerSize") {
public void map() {
((JSplitPane)getSource()).setDividerSize(i);
}});}
/**Maps <code>JSplitPane.setLastDividerLocation(int)</code> through queue*/
public void setLastDividerLocation(final int i) {
runMapping(new MapVoidAction("setLastDividerLocation") {
public void map() {
((JSplitPane)getSource()).setLastDividerLocation(i);
}});}
/**Maps <code>JSplitPane.setLeftComponent(Component)</code> through queue*/
public void setLeftComponent(final Component component) {
runMapping(new MapVoidAction("setLeftComponent") {
public void map() {
((JSplitPane)getSource()).setLeftComponent(component);
}});}
/**Maps <code>JSplitPane.setOneTouchExpandable(boolean)</code> through queue*/
public void setOneTouchExpandable(final boolean b) {
runMapping(new MapVoidAction("setOneTouchExpandable") {
public void map() {
((JSplitPane)getSource()).setOneTouchExpandable(b);
}});}
/**Maps <code>JSplitPane.setOrientation(int)</code> through queue*/
public void setOrientation(final int i) {
runMapping(new MapVoidAction("setOrientation") {
public void map() {
((JSplitPane)getSource()).setOrientation(i);
}});}
/**Maps <code>JSplitPane.setRightComponent(Component)</code> through queue*/
public void setRightComponent(final Component component) {
runMapping(new MapVoidAction("setRightComponent") {
public void map() {
((JSplitPane)getSource()).setRightComponent(component);
}});}
/**Maps <code>JSplitPane.setTopComponent(Component)</code> through queue*/
public void setTopComponent(final Component component) {
runMapping(new MapVoidAction("setTopComponent") {
public void map() {
((JSplitPane)getSource()).setTopComponent(component);
}});}
/**Maps <code>JSplitPane.setUI(SplitPaneUI)</code> through queue*/
public void setUI(final SplitPaneUI splitPaneUI) {
runMapping(new MapVoidAction("setUI") {
public void map() {
((JSplitPane)getSource()).setUI(splitPaneUI);
}});}
//End of mapping //
////////////////////////////////////////////////////////
private void expandTo(int index) {
makeComponentVisible();
JButtonOperator bo =
new JButtonOperator((JButton)getDivider().
waitSubComponent(new JButtonOperator.
JButtonFinder(ComponentSearcher.
getTrueChooser("JButton")),
index));
bo.copyEnvironment(getDivider());
bo.setVisualizer(new EmptyVisualizer());
bo.push();
}
/**
* Checks component type.
*/
public static class JSplitPaneFinder extends Finder {
/**
* Constructs JSplitPaneFinder.
* @param sf other searching criteria.
*/
public JSplitPaneFinder(ComponentChooser sf) {
super(JSplitPane.class, sf);
}
/**
* Constructs JSplitPaneFinder.
*/
public JSplitPaneFinder() {
super(JSplitPane.class);
}
}
private class ValueScrollAdjuster implements ScrollAdjuster {
int value;
public ValueScrollAdjuster(int value) {
this.value = value;
}
public int getScrollDirection() {
if(getDividerLocation() == value) {
return(ScrollAdjuster.DO_NOT_TOUCH_SCROLL_DIRECTION);
} else {
return((getDividerLocation() < value) ?
ScrollAdjuster.INCREASE_SCROLL_DIRECTION :
ScrollAdjuster.DECREASE_SCROLL_DIRECTION);
}
}
public int getScrollOrientation() {
return(getOrientation());
}
public String getDescription() {
return("Scroll to " + Integer.toString(value) + " value");
}
}
}