<!--

DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.

Copyright 1997-2010 Oracle and/or its affiliates. All rights reserved.

Oracle and Java are registered trademarks of Oracle and/or its affiliates.

Other names may be trademarks of their respective owners.

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.  Oracle designates this

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

by Oracle 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]"

Contributor(s):

The Original Software is NetBeans. The Initial Developer of the Original

Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun

Microsystems, Inc. All Rights Reserved.

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.

-->

<!--

-//NetBeans//DTD Mode Properties 2.4//EN

-->

<!-- The root element for mode properties. Consists of name, optional

     module information and several property sets for various types of

     user interface.

     Attribute "version" is versioning attribute which in fact specifies

     version of this DTD. Attribute is used to perform simple versioning

     without the need to use time-consuming xml validation using this DTD.

-->

<!ELEMENT mode (module?, name, kind, state, constraints?, (bounds | relative-bounds)?, frame?, active-tc?, empty-behavior?, slidingSide?, slide-in-size*) >

<!ATTLIST mode

    version CDATA #REQUIRED

>

<!-- Optional element for module information. Attribute name specifies name of

    module which defines this xml description. Module information is used for

    automatic removal of mode defined by module if module is disabled.

    If you want your module's mode to be removed automatically when

    your module is disabled, fill this element. When this element is missing,

    no automatic removal will be done.

 1) "name" code name of the module, can be either base code name or full code

    name with slash and release number. Examples for core module are: 

    "org.netbeans.core" or "org.netbeans.core/1"

 2) "spec" is specification version of the module which defines this xml description.

-->

<!ELEMENT module EMPTY >

<!ATTLIST module

    name CDATA #REQUIRED

    spec CDATA #IMPLIED

>

<!-- Element name

    "unique" represents unique ID of mode

    "includes" contains a list of names of other modes that were merged into this one.

-->

<!ELEMENT name      EMPTY >

<!ATTLIST name

    unique CDATA #REQUIRED

    includes CDATA #IMPLIED

>

<!-- Element kind

    "type" kind of mode "editor" or "view" or "sliding".

-->

<!ELEMENT kind      EMPTY >

<!ATTLIST kind

    type (editor | view | sliding) #REQUIRED

>

<!-- Element sliding side

    "side" direction of slide

-->

<!ELEMENT slidingSide      EMPTY >

<!ATTLIST slidingSide

    side (left | right | bottom | top) #REQUIRED

>

<!-- Element slide-in size

    "tc-id" TopComponent's ID

    "size" the size of the TopComponent (width or height) when it is slided-in

-->

<!ELEMENT slide-in-size      EMPTY >

<!ATTLIST slide-in-size

    tc-id CDATA #REQUIRED

    size CDATA #REQUIRED

>

<!-- Element state

    "type" state of mode "joined" (is inside of main window) or "separated" 

    (is in its own native window separated from main window).

    "minimized" state "true" means that any window opened in this mode is

    automatically minimized (slided out).

-->

<!ELEMENT state      EMPTY >

<!ATTLIST state

    type (joined | separated) #REQUIRED

    minimized (true | false) #IMPLIED

>

<!-- Absolute bounds rectangle of the mode, stored in attributes

     x, y, width, height, where x, y is location of left top point of bounds 

     rectangle.

     Relevant only for separate mode (window).

-->

<!ELEMENT bounds    EMPTY >

<!ATTLIST bounds

    x CDATA #REQUIRED

    y CDATA #REQUIRED

    width CDATA #REQUIRED

    height CDATA #REQUIRED

>

<!-- Relative (percentage) bounds rectangle of the mode, stored in attributes

     x, y, width, height, where x, y is location of left top point of bounds

     rectangle, it is relative to width of main window and height of area below

     main window.

     Relevant only for separate mode (window).

-->

<!ELEMENT relative-bounds    EMPTY >

<!ATTLIST relative-bounds

    x CDATA #REQUIRED

    y CDATA #REQUIRED

    width CDATA #REQUIRED

    height CDATA #REQUIRED

>

<!-- Frame properties.

    Relevant only for separate mode (window).

    Attribute "state" represents current state of frame.

    It is represented as bitwise mask - integer value.

    See java.awt.Frame for possible values.

    Default value is Frame.NORMAL (0).

-->

<!ELEMENT frame    EMPTY >

<!ATTLIST frame

    state CDATA #IMPLIED

>

<!-- Constraints describes path of mode in model tree.

     Path consists of array of values to describe path eg. [H1;V2].

     Relevant only for mode inside desktop

-->

<!ELEMENT constraints  (path*) >

<!ATTLIST constraints

>

<!-- Path describe path to mode in model tree.

     "orientation" sets orientation of splitter. "horizontal" means splitting

     along x axis - components are from left to right. "vertical" means splitting

     along y axis - components are from top to bottom.

     "number" sets number of cell in given split cell. It is integer number. Number defines

     position of given cell in array of cells. It is possible to define for example

     20 for first cell and 40 for second cell. Later it is possible to insert third cell between

     first and second by using 30 for third cell. It is usefull for platform to allow third party

     modules to modify (insert) their own modes to existing layout.

     Cells are counted from left to right in case of vertical split and

     from top to bottom in case of horizontal split.

     "weight" is double number from 0 to 1. It sets relative size of cell

     in given splitter. Default value is 0.5.

-->

<!ELEMENT path   EMPTY >

<!ATTLIST path

    orientation (horizontal | vertical) #REQUIRED

    number CDATA #REQUIRED

    weight CDATA #IMPLIED

>

<!-- Active TopComponent.

     "id" stores unique ID of active TopComponent

-->

<!ELEMENT active-tc  EMPTY >

<!ATTLIST active-tc

    id CDATA #IMPLIED

    prev-id CDATA #IMPLIED

>

<!-- Element "empty-behavior" describes behavior of mode when it is empty ie. does not contain

     any opened TopComponent.

     Attribute "permanent" can be "true" of "false". "true" means that mode remains in window

     system when it is empty ie. it does not contain any opened TopComponent. "false" means that

     mode is completely destroyed when it is empty. 

     Optional attribute, default value is "true".

     When mode is defined in module layer it is usually permanent ie. "true" is used.

-->

<!ELEMENT empty-behavior   EMPTY >

<!ATTLIST empty-behavior

    permanent (true | false) #IMPLIED

>

<change id="roles">

    <api name="winsys"/>

    <summary>Support multiple window system layouts.</summary>

    <version major="6" minor="42"/>

    <date day="24" month="5" year="2011"/>

    <author login="saubrecht"/>

    <compatibility addition="yes" binary="compatible" source="compatible" semantic="compatible" deprecation="no" deletion="no" modification="no"/>

    <description>

        It is possible to define multiple window system layouts and switch between

        them either at startup or at runtime.

        <br/>

        The default window system layout is defined in <pre>Windows2</pre> folder in XML layer.

        Additional layouts - <i>roles</i> or <i>perspectives</i> - are defined

        in <pre>Windows2/Roles</pre> folder. Each role has its own sub-folder.

        The name of that folder is role's unique name. The content of role folder

        is merged with Windows2 folder when the window system loads. Within a role

        it is possible to add new TopComponents, add TopComponent groups, docking

        modes, change the location of docking modes etc. To hide a file which

        is present in Windows2 folder and which isn't part of a role, add an empty

        file with the same name into role's sub-folder.

        <br/>

        User settings are stored separately for each role.

    </description>

    <issue number="198856"/>

</change>

    /**

     * Register window system listener to receive notifications when the window

     * system loads or saves.

     * @since 6.42

     */

    public void addWindowSystemListener( WindowSystemListener listener ) {

    }

    /**

     * Remove window system listener.

     * @since 6.42

     */

    public void removeWindowSystemListener( WindowSystemListener listener ) {

    }

/*

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

 *

 * Copyright 2011 Oracle and/or its affiliates. All rights reserved.

 *

 * Oracle and Java are registered trademarks of Oracle and/or its affiliates.

 * Other names may be trademarks of their respective owners.

 *

 * 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.  Oracle designates this

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

 * by Oracle 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 2011 Sun Microsystems, Inc.

 */

package org.openide.windows;

import java.util.EventObject;

/**

 * Configuration of window system. Use this class to change the window system behavior.

 * The configuration must be adjusted before window system loads.

 * 

 * @see WindowSystemListener#beforeLoad(org.openide.windows.WindowSystemConfiguration) 

 * 

 * @author S. Aubrecht

 * @since 6.42

 */

public final class WindowSystemConfiguration extends EventObject {

    private String roleName;

    public WindowSystemConfiguration( Object source ) {

        super( source );

    }

    /**

     * @return Name of current window system role or null when using the default

     * window system settings.

     */

    public String getRoleName() {

        return roleName;

    }

    /**

     * Set

     * @param roleName Name of the role to use when window system loads. Or null

     * value to use default window system settings.

     */

    public void setRoleName( String roleName ) {

        this.roleName = roleName;

    }

}

/*

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

 *

 * Copyright 2011 Oracle and/or its affiliates. All rights reserved.

 *

 * Oracle and Java are registered trademarks of Oracle and/or its affiliates.

 * Other names may be trademarks of their respective owners.

 *

 * 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.  Oracle designates this

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

 * by Oracle 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 2011 Sun Microsystems, Inc.

 */

package org.openide.windows;

import java.util.EventListener;

import java.util.EventObject;

/**

 * Window system listener to receive notifications when the window system loads

 * or saves its state to disk.

 * 

 * @see WindowManager#addWindowSystemListener(WindowSystemListener)

 * 

 * @author S. Aubrecht

 * @since 6.42

 */

public interface WindowSystemListener extends EventListener {

    /**

     * Invoked from EDT before the window system loads.

     * @param config Current window system configuration. Use it to change the

     * default window system behavior.

     */

    void beforeLoad( WindowSystemConfiguration config );

    /**

     * Invoked from EDT after the window system finished loading and is about

     * to show the main window and its content.

     * @param event 

     */

    void afterLoad( EventObject event );

    /**

     * Invoked from EDT before the window system starts saving its state to disk.

     * @param event 

     */

    void beforeSave( EventObject event );

    /**

     * Invoked from EDT when the window system finished saving its state to disk.

     * @param event 

     */

    void afterSave( EventObject event );

}