001    /*
002     * Copyright 2002-2004 the original author or authors.
003     * 
004     * Licensed under the Apache License, Version 2.0 (the "License"); you may not
005     * use this file except in compliance with the License. You may obtain a copy of
006     * the License at
007     * 
008     * http://www.apache.org/licenses/LICENSE-2.0
009     * 
010     * Unless required by applicable law or agreed to in writing, software
011     * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
012     * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
013     * License for the specific language governing permissions and limitations under
014     * the License.
015     */
016    package org.springframework.richclient.application.config;
017    
018    import org.springframework.richclient.application.ApplicationWindow;
019    
020    
021    /**
022     * Interface to be implemented by application components that want to be made aware
023     * of the {@link ApplicationWindow} that they have been created within.
024     * 
025     * Note that simply implementing this interface is not enough to ensure that your components
026     * are injected with the {@code ApplicationWindow} reference. This is dependent on the factory 
027     * or framework code that instantiates the components. For example, the 
028     * {@link DefaultApplicationLifecycleAdvisor} class is a framework component that can instantiate 
029     * command objects for use in toolbars, menus etc. If any of these commands implement 
030     * {@link ApplicationWindowAware}, the lifecycle advisor will inject the appropriate 
031     * {@link ApplicationWindow} into them.
032     */
033    public interface ApplicationWindowAware {
034        
035        /**
036         * Sets the reference to the application window that this object was created within. 
037         *
038         * @param window The application window containing this component.
039         */
040        public void setApplicationWindow(ApplicationWindow window);
041        
042    }