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.core.spi.multiview;
043:
044: import javax.swing.Action;
045:
046: /**
047: * instances of this class describe the MultiViewElement's state when the component is
048: * about to be closed. (See {@link org.netbeans.core.spi.multiview.MultiViewElement#canCloseElement})
049: * New instances are created by {@link org.netbeans.core.spi.multiview.MultiViewFactory#createUnsafeCloseState} factory method.
050: */
051: public final class CloseOperationState {
052:
053: /**
054: * Singleton instance of a close operation state, to be used whenever {@link org.netbeans.core.spi.multiview.MultiViewElement} is in consistent state
055: * and can be safely closed.
056: */
057: public static final CloseOperationState STATE_OK = MultiViewFactory
058: .createSafeCloseState();
059:
060: private boolean canClose;
061: private String id;
062: private Action proceedAction;
063: private Action discardAction;
064:
065: CloseOperationState(boolean close, String warningId,
066: Action proceed, Action discard) {
067: canClose = close;
068: proceedAction = proceed;
069: discardAction = discard;
070: id = warningId;
071: }
072:
073: /**
074: * The return value denotes wheather the {@link org.netbeans.core.spi.multiview.MultiViewElement} can be closed or not.
075: * @return can close element or not
076: */
077:
078: public boolean canClose() {
079: return canClose;
080: }
081:
082: /**
083: * A preferably unique id of the reason why the element cannot be closed.
084: * {@link org.netbeans.core.spi.multiview.CloseOperationHandler} implementation can use it when deciding about UI shown or action taken.
085: */
086:
087: public String getCloseWarningID() {
088: return id;
089: }
090:
091: /**
092: * Action is used when user wants to complete the closing of the component without loosing changed data.
093: * Used by {@link org.netbeans.core.spi.multiview.CloseOperationHandler}.
094: * @return action which will be triggered when user confirms changes
095: */
096: public Action getProceedAction() {
097: return proceedAction;
098: }
099:
100: /**
101: * Action is used when user wants to complete the closing of the component and discard any changes.
102: * Used by {@link org.netbeans.core.spi.multiview.CloseOperationHandler}.
103: * @return action which will be triggered when user discards changes
104: */
105:
106: public Action getDiscardAction() {
107: return discardAction;
108: }
109:
110: }
|