com.pekinsoft.framework.FrameView Maven / Gradle / Ivy

Go to download
/*
 * Copyright (C) 2024 PekinSOFT Systems
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see .
 * 
 * *****************************************************************************
 *  Project    :   application-framework-api
 *  Class      :   FrameView.java
 *  Author     :   Sean Carrick
 *  Created    :   Jul 14, 2024
 *  Modified   :   Jul 14, 2024
 *  
 *  Purpose: See class JavaDoc for explanation
 *  
 *  Revision History:
 *  
 *  WHEN          BY                   REASON
 *  ------------  -------------------  -----------------------------------------
 *  Jul 14, 2024  Sean Carrick         Initial creation.
 * *****************************************************************************
 */

package com.pekinsoft.framework;

import javax.swing.JFrame;
import javax.swing.JRootPane;
import javax.swing.JToolBar;
import java.lang.System.Logger;
import java.lang.System.Logger.Level;

public class FrameView extends View {

    private final Logger logger = System.getLogger(FrameView.class.getName());
    private JFrame frame = null;
    private JToolBar toolBar;

    public FrameView(ApplicationContext context) {
        super(context);
    }

    /**
     * Return the JFrame used to show this View
     *
     * 
     * This method may be called at any time; the JFrame is created lazily and
     * cached. For example:{@snippet lang="java":
     *  @Override protected void startup() {
     *     getFrame().setJMenuBar(createMenuBar());
     *     show(createMainPanel());
     * }
     * }
     *
     * @return this application's main frame
     */
    public JFrame getFrame() {
        if (frame == null) {
            String title = getContext().getResourceMap().getString("Application.title");
            frame = new JFrame(title);
            frame.setName("mainFrame");
        }
        return frame;
    }

    /**
     * Sets the JFrame use to show this View
     * 
     * This method should be called from the startup method by a subclass that
     * wants to construct and initialize the main frame itself. Most
     * applications can rely on the fact that {@code getFrame} lazily constructs
     * the main frame and initializes the {@code frame} property.
     * 
     * If the main frame property was already initialized, either implicitly
     * through a call to {@code getFrame} or by explicitly calling this method,
     * an IllegalStateException is thrown. If {@code frame} is null, an
     * IllegalArgumentException is thrown.
     * 
     * This property is bound.
     *
     *
     *
     * @param frame the new value of the frame property
     * @see #getFrame
     */
    public void setFrame(JFrame frame) {
        if (frame == null) {
            throw new IllegalArgumentException("{@code null} JFrame");
        }
        if (this.frame != null) {
            throw new IllegalStateException("frame already set");
        }
        this.frame = frame;
        firePropertyChange("frame", null, this.frame);
    }

    @Override
    public JRootPane getRootPane() {
        return getFrame().getRootPane();
    }

    @Override
    public void setToolBar(JToolBar toolBar, boolean update) {
        this.toolBar = toolBar;
        super.setToolBar(toolBar, true);
    }
}