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.api.options;
043:
044: import java.util.Arrays;
045: import java.util.logging.Logger;
046: import org.netbeans.modules.options.CategoryModel;
047: import org.netbeans.modules.options.OptionsDisplayerImpl;
048: import org.openide.util.Mutex;
049:
050: /**
051: * Permits Options Dialog to open the options dialog with some category pre-selected.
052: * @since 1.5
053: * @author Radek Matous
054: */
055: public final class OptionsDisplayer {
056: private static final OptionsDisplayer INSTANCE = new OptionsDisplayer();
057: private final OptionsDisplayerImpl impl = new OptionsDisplayerImpl(
058: false);
059: private static Logger log = Logger.getLogger(OptionsDisplayer.class
060: .getName());
061:
062: private OptionsDisplayer() {
063: }
064:
065: /**
066: * Get the default <code>OptionsDisplayer</code>
067: * @return the default instance
068: */
069: public static OptionsDisplayer getDefault() {
070: return INSTANCE;
071: }
072:
073: /**
074: * Open the options dialog with no guarantee which category is pre-selected.
075: * @return true if optins dialog was sucesfully opened with some pre-selected
076: * category. If no category is registered at all then false will be returned and
077: * options dialog won't be opened.
078: */
079: public boolean open() {
080: return open(CategoryModel.getInstance().getCurrentCategoryID());
081: }
082:
083: /**
084: * Open the options dialog with some category pre-selected.
085: * @param categoryId ID representing required category which is registration name
086: * (e.g. "FooOptionsPanelID" for following registration:
087: * <pre style="background-color: rgb(255, 255, 153);">
088: * <folder name="OptionsDialog">
089: * <file name="FooOptionsPanelID.instance">
090: * <attr name="instanceClass" stringvalue="org.foo.FooOptionsPanel"/>
091: * </file>
092: * </folder></pre>
093: * @return true if optins dialog was sucesfully opened with required category pre-selected.
094: * If this method is called when options dialog is already opened then this method
095: * will return immediately false without affecting currently selected category
096: * in opened options dialog.
097: * If <code>categoryId</code> passed as a parameter does not correspond to any
098: * of registered categories then false is returned and options dialog is not opened
099: * at all (e.g. in case that module providing such category is not installed or enabled).
100: */
101: public boolean open(final String categoryId) {
102: log.fine("Open Options Dialog: " + categoryId); //NOI18N
103: return openImpl(categoryId);
104: }
105:
106: private boolean openImpl(final String categoryId) {
107: Boolean retval = Mutex.EVENT
108: .readAccess(new Mutex.Action<Boolean>() {
109: public Boolean run() {
110: Boolean r = impl.isOpen();
111: boolean retvalForRun = !r;
112: if (retvalForRun) {
113: retvalForRun = Arrays.asList(
114: CategoryModel.getInstance()
115: .getCategoryIDs())
116: .contains(categoryId);
117: if (!retvalForRun) {
118: log.warning("Unknown categoryId: "
119: + categoryId); //NOI18N
120: }
121: } else {
122: log.warning("Options Dialog is opened"); //NOI18N
123: }
124: if (retvalForRun) {
125: impl.showOptionsDialog(categoryId);
126: }
127: return Boolean.valueOf(retvalForRun);
128: }
129: });
130: return retval;
131: }
132: }
|