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.api.visual.action;
042:
043: import org.netbeans.api.visual.widget.Widget;
044:
045: import javax.swing.*;
046: import java.awt.*;
047: import java.util.EnumSet;
048:
049: /**
050: * This interface controls an in-place editor of an in-place editor action.
051: *
052: * @author David Kaspar
053: */
054: public interface InplaceEditorProvider<C extends JComponent> {
055:
056: /**
057: * Represents possible directions for expansion of an editor component.
058: */
059: public enum ExpansionDirection {
060:
061: /**
062: * Allow expansion to the left.
063: */
064: LEFT,
065:
066: /**
067: * Allow expansion to the right.
068: */
069: RIGHT,
070:
071: /**
072: * Allow expansion to the top.
073: */
074: TOP,
075:
076: /**
077: * Allow expansion to the bottom.
078: */
079: BOTTOM
080:
081: }
082:
083: /**
084: * This is an interface of editor action supplied to the methods in the provider.
085: */
086: interface EditorController {
087:
088: /**
089: * Returns whether an in-place editor is visible.
090: * @return true, if visible; false, if not visible
091: */
092: boolean isEditorVisible();
093:
094: /**
095: * Opens an in-place editor on a specified widget.
096: * @param widget the widget
097: * @return true, if the editor is really opened
098: */
099: boolean openEditor(Widget widget);
100:
101: /**
102: * Closes the current in-place editor.
103: * @param commit whether the current value in the in-place editor is approved by an user
104: */
105: void closeEditor(boolean commit);
106:
107: /**
108: * Notify the boundary of an editor component is changed and auto-expansion should be recalculated.
109: */
110: void notifyEditorComponentBoundsChanged();
111:
112: }
113:
114: /**
115: * Called to notify about opening an in-place editor.
116: * @param controller the editor controller
117: * @param widget the widget where the editor is opened
118: * @param editor the editor component
119: */
120: void notifyOpened(EditorController controller, Widget widget,
121: C editor);
122:
123: /**
124: * Called to notify about closing an in-place editor.
125: * @param controller the editor controller
126: * @param widget the widget where the editor is opened
127: * @param editor the editor component
128: * @param commit true, if the current value is approved by user and
129: * should be used; false if the current value is discarded by an user
130: */
131: void notifyClosing(EditorController controller, Widget widget,
132: C editor, boolean commit);
133:
134: /**
135: * Creates an in-place editor component for a specified widget. Called to acquire the component which should be added into the scene.
136: * @param controller the editor controller
137: * @param widget the widget where the editor is going to be opened
138: * @return the editor component
139: */
140: C createEditorComponent(EditorController controller, Widget widget);
141:
142: /**
143: * Called to obtain the initial boundary editor component in view coordination system.
144: * @param controller the editor controller
145: * @param widget the widget where the editor is going to be opened
146: * @param editor the editor component
147: * @param viewBounds the precalculated boundary of the editor component
148: * @return the boundary of editor component in view coordination system;
149: * if null, then the viewBounds are automatically used
150: */
151: public Rectangle getInitialEditorComponentBounds(
152: EditorController controller, Widget widget, C editor,
153: Rectangle viewBounds);
154:
155: /**
156: * Called to obtain directions where an editor component can expand to.
157: * @param controller the editor controller
158: * @param widget the widget where the editor is going to be opened
159: * @param editor the editor component
160: * @return the set of directions where the editor component can expand to;
161: * if null, then the editor component is not expanded to any direction
162: */
163: public EnumSet<ExpansionDirection> getExpansionDirections(
164: EditorController controller, Widget widget, C editor);
165:
166: }
|