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-2007 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.modules.xml.xam.ui.actions;
043:
044: import org.netbeans.modules.xml.xam.Component;
045: import org.netbeans.modules.xml.xam.ui.XAMUtils;
046: import org.netbeans.modules.xml.xam.ui.cookies.ViewComponentCookie;
047: import org.openide.nodes.Node;
048: import org.openide.util.HelpCtx;
049: import org.openide.util.NbBundle;
050:
051: /**
052: * Interface GotoType defines a place where an editor can be opened
053: * for a particular component.
054: *
055: * @author Nathan Fiedler
056: */
057: public abstract class GotoType {
058:
059: /**
060: * Finds the component that the given node represents. Subclasses may
061: * wish to override this to retrieve the component in different manner.
062: *
063: * @param node the Node from which to get the component.
064: * @return the component, or null if none.
065: */
066: protected Component getComponent(Node node) {
067: return XAMUtils.getComponent(node);
068: }
069:
070: /**
071: * Help context for the goto type.
072: *
073: * @return the help context
074: */
075: public HelpCtx getHelpCtx() {
076: return HelpCtx.DEFAULT_HELP;
077: }
078:
079: /**
080: * Returns the name of this type, to be displayed in a menu. Ideally
081: * this should be the name of the view or editor that this type will
082: * open the component in (e.g. "Design").
083: *
084: * @return name of this type.
085: */
086: public String getName() {
087: return NbBundle.getMessage(GotoType.class, "LBL_GoTo");
088: }
089:
090: /**
091: * Return the view in which this type will show the component.
092: *
093: * @return component view.
094: */
095: protected abstract ViewComponentCookie.View getView();
096:
097: /**
098: * Show the given node in the view this type represents.
099: *
100: * @param node the Node to be shown.
101: */
102: public void show(Node node) {
103: Component comp = getComponent(node);
104: ViewComponentCookie.View view = getView();
105: ViewComponentCookie cookie = XAMUtils.getViewCookie(comp, view);
106: if (cookie != null) {
107: cookie.view(view, comp);
108: }
109: }
110: }
|