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    import org.springframework.richclient.core.DescribedElement;
021    import org.springframework.richclient.core.VisualizedElement;
022    
023    public interface PageDescriptor extends DescribedElement, VisualizedElement {
024        public String getId();
025    
026        public void buildInitialLayout(PageLayoutBuilder pageLayout);
027    
028        /**
029         * Create a command that when executed, will attempt to show the
030         * page component described by this descriptor in the provided
031         * application window.
032         *
033         * @param window The window
034         *
035         * @return The show page component command.
036         */
037        public ActionCommand createShowPageCommand(ApplicationWindow window);
038    
039        public CommandButtonLabelInfo getShowPageCommandLabel();
040    
041    
042    }