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: package org.netbeans.modules.versioning.spi;
042:
043: import javax.swing.*;
044: import java.awt.Image;
045:
046: /**
047: * Anntoator provides these services based on files' versioning status:
048: * - coloring for labels (file and folder names, editor tabs, etc.)
049: * - badging (modification of node icons)
050: * - provides set of Actions
051: *
052: * @author Maros Sandor
053: */
054: public abstract class VCSAnnotator {
055:
056: /**
057: * Protected constructor, does nothing.
058: */
059: protected VCSAnnotator() {
060: }
061:
062: /**
063: * Specifies destination of returned actions. Destination MainMenu means actions will be user to construct main
064: * application menu, PopupMenu means actions will be used to construct popup menus on projects, files and folders.
065: *
066: * @see #getActions
067: */
068: public enum ActionDestination {
069: MainMenu, PopupMenu
070: };
071:
072: /**
073: * Allows a versioning system to decorate given name with HTML markup. This can be used to highlight file status.
074: *
075: * @param name text to decorate
076: * @param context a context this name represents
077: * @return decorated name or the same name left undecorated
078: */
079: public String annotateName(String name, VCSContext context) {
080: return name;
081: }
082:
083: /**
084: * Allows a versioning system to decorate given icon (badging). This can be used to highlight file status.
085: *
086: * @param icon an icon to decorate
087: * @param context a context this icon represents
088: * @return decorated icon or the same icon left undecorated
089: */
090: public Image annotateIcon(Image icon, VCSContext context) {
091: return icon;
092: }
093:
094: /**
095: * Returns set of actions to offer to the user use on a given context.
096: *
097: * @param context context on which returned actions should operate
098: * @param destination where this actions will be used
099: * @return Action[] array of actions to display for the given context, use null for separators
100: */
101: public Action[] getActions(VCSContext context,
102: ActionDestination destination) {
103: return new Action[0];
104: }
105: }
|