001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common
008: * Development and Distribution License("CDDL") (collectively, the
009: * "License"). You may not use this file except in compliance with the
010: * License. You can obtain a copy of the License at
011: * http://www.netbeans.org/cddl-gplv2.html
012: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
013: * specific language governing permissions and limitations under the
014: * License. When distributing the software, include this License Header
015: * Notice in each file and include the License file at
016: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
017: * particular file as subject to the "Classpath" exception as provided
018: * by Sun in the GPL Version 2 section of the License file that
019: * accompanied this code. If applicable, add the following below the
020: * License Header, with the fields enclosed by brackets [] replaced by
021: * your own identifying information:
022: * "Portions Copyrighted [year] [name of copyright owner]"
023: *
024: * Contributor(s):
025: *
026: * The Original Software is NetBeans. The Initial Developer of the Original
027: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
028: * Microsystems, Inc. All Rights Reserved.
029: *
030: * If you wish your version of this file to be governed by only the CDDL
031: * or only the GPL Version 2, indicate your decision by adding
032: * "[Contributor] elects to include this software in this distribution
033: * under the [CDDL or GPL Version 2] license." If you do not indicate a
034: * single choice of license, a recipient has the option to distribute
035: * your version of this file under either the CDDL, the GPL Version 2 or
036: * to extend the choice of license to its licensees as provided above.
037: * However, if you add GPL Version 2 code and therefore, elected the GPL
038: * Version 2 license, then the option applies only if the new code is
039: * made subject to such option by the copyright holder.
040: */
041:
042: package org.netbeans.jellytools;
043:
044: import java.awt.Component;
045: import java.awt.Container;
046: import javax.swing.JComponent;
047: import org.netbeans.jellytools.actions.Action;
048: import org.netbeans.jellytools.actions.OutputWindowViewAction;
049: import org.netbeans.jemmy.ComponentChooser;
050: import org.netbeans.jemmy.ComponentSearcher;
051: import org.netbeans.jemmy.operators.JTabbedPaneOperator;
052:
053: /**
054: * Provides access to the Output window and it's subcomponents.
055: * Output window might contain one or more output tabs.
056: * It is better to use {@link OutputTabOperator} if you want to work
057: * with a particular output tab.
058: * <p>
059: * Usage:<br>
060: * <pre>
061: * OutputOperator oo = new OutputOperator();
062: * System.out.println("TEXT from active output tab="+oo.getText().substring(0, 10));
063: * // get OutputTabOperator instance
064: * OutputTabOperator oto = oo.getOutputTab("myoutput");
065: * // or
066: * // OutputTabOperator oto = new OutputTabOperator("myoutput");
067: * // call an action from context menu
068: * oo.find();
069: * // close output
070: * oo.close();
071: * </pre>
072: *
073: * @author Jiri.Skrivanek@sun.com
074: * @see OutputTabOperator
075: */
076: public class OutputOperator extends TopComponentOperator {
077:
078: private static final Action invokeAction = new OutputWindowViewAction();
079:
080: /** Waits for output window top component and creates a new operator for it. */
081: public OutputOperator() {
082: /* In IDE OutputWindow top component is singleton but in sense of
083: jellytools, it is not singleton. It can be closed/hidden and
084: again opened/shown, so it make sense to wait for OutputWindow
085: top component again.
086: */
087: super (waitTopComponent(null, null, 0, outputSubchooser));
088: }
089:
090: /** Opens Output from main menu Window|Output and returns OutputOperator.
091: * @return instance of OutputOperator
092: */
093: public static OutputOperator invoke() {
094: invokeAction.perform();
095: return new OutputOperator();
096: }
097:
098: /** Returns active OutputTabOperator instance regardless it is the only one in
099: * output or it is in tabbed pane.
100: * @return active OutputTabOperator instance
101: */
102: private OutputTabOperator getActiveOutputTab() {
103: OutputTabOperator outputTabOper;
104: if (null != JTabbedPaneOperator.findJTabbedPane(
105: (Container) getSource(), ComponentSearcher
106: .getTrueChooser(""))) {
107: outputTabOper = new OutputTabOperator(
108: ((JComponent) new JTabbedPaneOperator(this )
109: .getSelectedComponent()));
110: outputTabOper.copyEnvironment(this );
111: } else {
112: outputTabOper = new OutputTabOperator("");
113: }
114: return outputTabOper;
115: }
116:
117: /**
118: * Returns instance of OutputTabOperator of given name.
119: * It is activated by default.
120: * @param tabName name of tab to be selected
121: * @return instance of OutputTabOperator
122: */
123: public OutputTabOperator getOutputTab(String tabName) {
124: return new OutputTabOperator(tabName);
125: }
126:
127: /**
128: * Returns text from the active tab.
129: * @return text from the active tab
130: */
131: public String getText() {
132: return getActiveOutputTab().getText();
133: }
134:
135: /********************************** Actions ****************************/
136:
137: /** Performs copy action on active tab. */
138: public void copy() {
139: getActiveOutputTab().copy();
140: }
141:
142: /** Performs find action on active tab. */
143: public void find() {
144: getActiveOutputTab().find();
145: }
146:
147: /** Performs find next action on active tab. */
148: public void findNext() {
149: getActiveOutputTab().findNext();
150: }
151:
152: /** Performs select all action on active tab. */
153: public void selectAll() {
154: getActiveOutputTab().selectAll();
155: }
156:
157: /** Performs next error action on active tab. */
158: public void nextError() {
159: getActiveOutputTab().nextError();
160: }
161:
162: /** Performs next error action on active tab. */
163: public void previousError() {
164: getActiveOutputTab().previousError();
165: }
166:
167: /** Performs wrap text action on active tab. */
168: public void wrapText() {
169: getActiveOutputTab().wrapText();
170: }
171:
172: /** Performs clear action on active tab. */
173: public void clear() {
174: getActiveOutputTab().clear();
175: }
176:
177: /** Performs save as action on active tab. */
178: public void saveAs() {
179: getActiveOutputTab().saveAs();
180: }
181:
182: /** Performs verification by accessing all sub-components. */
183: public void verify() {
184: // do nothing because output top component can be empty
185: }
186:
187: /** SubChooser to determine OutputWindow TopComponent
188: * Used in constructor.
189: */
190: private static final ComponentChooser outputSubchooser = new ComponentChooser() {
191: public boolean checkComponent(Component comp) {
192: return comp.getClass().getName().endsWith("OutputWindow"); //NOI18N
193: }
194:
195: public String getDescription() {
196: return "component instanceof org.netbeans.core.output2.OutputWindow";// NOI18N
197: }
198: };
199: }
|