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;
017    
018    import org.springframework.richclient.command.ActionCommand;
019    import org.springframework.richclient.command.config.CommandButtonLabelInfo;
020    
021    /**
022     * Metadata about a view; a view descriptor is effectively a singleton view
023     * definition. A descriptor also acts as a factory which produces new instances
024     * of a given view when requested, typically by a requesting application page. A
025     * view descriptor can also produce a command which launches a view for display
026     * on the page within the current active window.
027     *
028     * @author Keith Donald
029     */
030    public interface ViewDescriptor extends PageComponentDescriptor {
031    
032        /**
033         * Create a command that when executed, will attempt to show the
034         * page component described by this descriptor in the provided
035         * application window.
036         *
037         * @param window The window
038         *
039         * @return The show page component command.
040         */
041        public ActionCommand createShowViewCommand(ApplicationWindow window);
042    
043        public CommandButtonLabelInfo getShowViewCommandLabel();
044    
045    }