01: /*
02: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
03: *
04: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
05: *
06: * The contents of this file are subject to the terms of either the GNU
07: * General Public License Version 2 only ("GPL") or the Common
08: * Development and Distribution License("CDDL") (collectively, the
09: * "License"). You may not use this file except in compliance with the
10: * License. You can obtain a copy of the License at
11: * http://www.netbeans.org/cddl-gplv2.html
12: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
13: * specific language governing permissions and limitations under the
14: * License. When distributing the software, include this License Header
15: * Notice in each file and include the License file at
16: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
17: * particular file as subject to the "Classpath" exception as provided
18: * by Sun in the GPL Version 2 section of the License file that
19: * accompanied this code. If applicable, add the following below the
20: * License Header, with the fields enclosed by brackets [] replaced by
21: * your own identifying information:
22: * "Portions Copyrighted [year] [name of copyright owner]"
23: *
24: * Contributor(s):
25: *
26: * The Original Software is NetBeans. The Initial Developer of the Original
27: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
28: * Microsystems, Inc. All Rights Reserved.
29: *
30: * If you wish your version of this file to be governed by only the CDDL
31: * or only the GPL Version 2, indicate your decision by adding
32: * "[Contributor] elects to include this software in this distribution
33: * under the [CDDL or GPL Version 2] license." If you do not indicate a
34: * single choice of license, a recipient has the option to distribute
35: * your version of this file under either the CDDL, the GPL Version 2 or
36: * to extend the choice of license to its licensees as provided above.
37: * However, if you add GPL Version 2 code and therefore, elected the GPL
38: * Version 2 license, then the option applies only if the new code is
39: * made subject to such option by the copyright holder.
40: */
41:
42: package org.netbeans.core.spi.multiview;
43:
44: import java.awt.Image;
45: import org.openide.util.HelpCtx;
46:
47: /** Description of multi view element. Implementations should be lightweight
48: * and fast. Creating heavyweight {@link org.netbeans.core.spi.multiview.MultiViewElement} instances asociated with
49: * Swing visual representation should be done lazily in {@link #createElement} methods.
50: * The implementing class should be serializable. For performance reasons,
51: * don't include the element into serialization of the description. That one will be handled
52: * separately when necessary.
53: *
54: * @author Dafe Simonek, Milos Kleint
55: */
56: public interface MultiViewDescription {
57:
58: /** Gets persistence type of multi view element, the TopComponent will decide
59: * on it's onw persistenceType based on the sum of all it's elements.
60: * {@link org.openide.windows.TopComponent#PERSISTENCE_ALWAYS} has higher priority than {@link org.openide.windows.TopComponent#PERSISTENCE_ONLY_OPENED}
61: * and {@link org.openide.windows.TopComponent#PERSISTENCE_NEVER} has lowest priority.
62: * The {@link org.openide.windows.TopComponent} will be stored only if at least one element requesting persistence
63: * was made visible.
64: */
65: public int getPersistenceType();
66:
67: /**
68: * Gets localized display name of multi view element. Will be placed on the Element's toggle button.
69: *@return localized display name
70: */
71: public String getDisplayName();
72:
73: /**
74: * Icon for the MultiViewDescription's multiview component. Will be shown as TopComponent's icon
75: * when this element is selected.
76: * @return the icon of multi view element
77: */
78: public Image getIcon();
79:
80: /** Get the help context of multi view element.
81: */
82: public HelpCtx getHelpCtx();
83:
84: /**
85: * A Description's contribution
86: * to unique {@link org.openide.windows.TopComponent}'s Id returned by <code>getID</code>. Returned value is used as starting
87: * value for creating unique {@link org.openide.windows.TopComponent} ID for whole enclosing multi view
88: * component.
89: * Value should be preferably unique, but need not be.
90: */
91: public String preferredID();
92:
93: /** Creates and returns asociated multi view element. it is called just once during the lifecycle of the
94: * multiview component.
95: * @return the multiview element associated with this description
96: */
97: public MultiViewElement createElement();
98:
99: }
|