import org.openide.windows.RetainLocation;

/*

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.

 *

 * Copyright 2010 Sun Microsystems, Inc. All rights reserved.

 *

 * The contents of this file are subject to the terms of either the GNU

 * General Public License Version 2 only ("GPL") or the Common

 * Development and Distribution License("CDDL") (collectively, the

 * "License"). You may not use this file except in compliance with the

 * License. You can obtain a copy of the License at

 * http://www.netbeans.org/cddl-gplv2.html

 * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the

 * specific language governing permissions and limitations under the

 * License.  When distributing the software, include this License Header

 * Notice in each file and include the License file at

 * nbbuild/licenses/CDDL-GPL-2-CP.  Sun designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Sun in the GPL Version 2 section of the License file that

 * accompanied this code. If applicable, add the following below the

 * License Header, with the fields enclosed by brackets [] replaced by

 * your own identifying information:

 * "Portions Copyrighted [year] [name of copyright owner]"

 *

 * If you wish your version of this file to be governed by only the CDDL

 * or only the GPL Version 2, indicate your decision by adding

 * "[Contributor] elects to include this software in this distribution

 * under the [CDDL or GPL Version 2] license." If you do not indicate a

 * single choice of license, a recipient has the option to distribute

 * your version of this file under either the CDDL, the GPL Version 2 or

 * to extend the choice of license to its licensees as provided above.

 * However, if you add GPL Version 2 code and therefore, elected the GPL

 * Version 2 license, then the option applies only if the new code is

 * made subject to such option by the copyright holder.

 *

 * Contributor(s):

 *

 * Portions Copyrighted 2010 Sun Microsystems, Inc.

 */

package org.openide.windows;

import java.lang.annotation.ElementType;

import java.lang.annotation.Target;

import java.lang.annotation.Retention;

import static java.lang.annotation.RetentionPolicy.*;

/**

 * Annotation which can be applied to TopComponents whose persistence type

 * is PERSISTENCE_NEVER to allow them to remember the location they were

 * docked into

 *

 * @since 6.32

 * @author Tim Boudreau

 */

@Retention (RUNTIME)

@Target (ElementType.TYPE)

public @interface RetainLocation {

    /** The name of the docking location (Mode) this component should be

     * docked into by default, if there is no stored value.

     * @return The Mode name

     */

    String value();

}

import org.openide.util.NbPreferences;

    private transient String modeName;

    private static final String MODE_ID_PREFERENCES_KEY_INFIX = "_modeId_"; //NOI18N

    @Override

    public void addNotify() {

        super.addNotify();

        if (isPersistLocation()) {

            Mode m = WindowManager.getDefault().findMode(this);

            if (m != null) {

                modeName = m.getName();

                if (modeName == null) {

                    modeName = getClass().getAnnotation(

                               RetainLocation.class).value();

                }

                NbPreferences.forModule(getClass()).put(getModeIdKey(), modeName);

            }

        }

    }

    private boolean isPersistLocation() {

        boolean result = getPersistenceType() == PERSISTENCE_NEVER &&

               getClass().getAnnotation(RetainLocation.class) != null;

        assert annotationAndPersistenceTypeAreCompatible();

        return result;

    }

    private boolean annotationAndPersistenceTypeAreCompatible() {

        if (getPersistenceType() != PERSISTENCE_NEVER &&

            getClass().getAnnotation(RetainLocation.class) != null) {

            Logger.getLogger(TopComponent.class.getName()).log(Level.WARNING,

                "Useless to annotate a TopComponent with @RetainLocation if " + //NOI18N

                "its persistence type is not PERSISTENCE_NEVER: {0}", //NOI18N

                new Object[] { getClass().getName() });

        }

        return true;

    }

    private String getModeIdKey() {

        return getClass().getName() + MODE_ID_PREFERENCES_KEY_INFIX + preferredID();

    }

        if (isPersistLocation()) {

            modeName = NbPreferences.forModule(getClass()).get(getModeIdKey(), null);

            if (modeName == null) {

                modeName = getClass().getAnnotation(

                           RetainLocation.class).value();

            }

            Mode mode = WindowManager.getDefault().findMode(modeName);

            if (mode != null) {

                mode.dockInto(this);

            }

        }