com.globalmentor.swing.AbstractMDIDocumentPanel Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of globalmentor-swing Show documentation
GlobalMentor Java Swing library.
The newest version!
/*
 * Copyright © 1996-2009 GlobalMentor, Inc. 
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.globalmentor.swing;

import java.awt.*;
import java.io.*;
import com.globalmentor.model.ObjectState;
import com.globalmentor.rdf.*;

/**
 * An application panel that contains a document for multiple document interface architecture.
 * @author Garret Wilson
 */
@Deprecated
public abstract class AbstractMDIDocumentPanel extends ToolStatusPanel implements ObjectState { //TODO eventually delete this class and replace it with ResourceApplicationPanel
//TODO make this class implement com.globalmentor.io.Streamable as well (create that class)

	/** The document file. */
	//TODO del when works	private File file=null;

	/** @return The file used by this document, or null if unknown. */
	//TODO del when works	public File getFile() {return file;}

	/**
	 * Sets the file used by this document.
	 * @param newFile The file used, or null if unknown.
	 */
	//TODO del when works	public void setFile(final File newFile) {file=newFile;}

	//TODO del when works	private final RDF rdf;  //TODO testing

	//TODO del when works	protected RDF getRDF() {return rdf;}  //TODO testing; comment

	/** Whether the data has been modified; the default is not modified. */
	private boolean modified = false;

	/** @return Whether the datahas been modified. */
	public boolean isModified() {
		return modified;
	}

	/**
	 * Sets whether the data has been modified. This is a bound property.
	 * @param newModified The new modification status.
	 */
	public void setModified(final boolean newModified) {
		final boolean oldModified = modified; //get the old modified value
		if(oldModified != newModified) { //if the value is really changing
			modified = newModified; //update the value
			//show that the modified property has changed
			firePropertyChange(MODIFIED_PROPERTY, Boolean.valueOf(oldModified), Boolean.valueOf(newModified));
		}
	}

	/** The resource that dscribes this document. */
	private RDFResource resource;

	/** @return The non-null resource that describes this document. */
	public RDFResource getObject() {
		return resource;
	}

	/**
	 * Sets the resource that describes this document.
	 * @param resource The resource that describes this document.
	 */
	public void setObject(final RDFResource resource) {
		this.resource = resource;
	} //TODO maybe throw an exception if the resource is null

	/**
	 * Sets the reference URI of the document. This results in the resource returned by getResource() being changed to another object, invalidating
	 * the old resource description.
	 * @param referenceURI The new reference URI of the document.
	 * @throws IllegalArgumentException Thrown if the provided reference URI is null.
	 */
	/*TODO del when works
		public void setReferenceURI(final URI referenceURI) throws IllegalArgumentException
		{
			resource=new DefaultRDFResource(resource, referenceURI); //create a new resource with a different URI TODO change to get this from the data model
		}
	*/

	/** Default constructor. */
	public AbstractMDIDocumentPanel() {
		//TODO del		super();  //construct the parent
		this(true); //do the default construction
	}

	/**
	 * Constructor with optional initialization.
	 * @param initialize true if the panel should initialize itself by calling the initialization methods.
	 */
	protected AbstractMDIDocumentPanel(final boolean initialize) {
		//TODO del		super();  //construct the parent
		this(false, false, initialize); //do the default construction, initializing the panel if needed
	}

	/**
	 * Application component constructor with optional initialization.
	 * @param applicationComponent The new component for the center of the panel.
	 * @param initialize true if the panel should initialize itself by calling the initialization methods.
	 */
	protected AbstractMDIDocumentPanel(final Component applicationComponent, final boolean initialize) {
		//TODO del		super(applicationComponent);  //construct the parent
		this(true, true, false); //do the default construction without initializing
		setContentComponent(applicationComponent); //set the application component
		if(initialize) //if we should initialize
			initialize(); //initialize the panel
	}

	/**
	 * Application component constructor.
	 * @param applicationComponent The new component for the center of the panel.
	 */
	public AbstractMDIDocumentPanel(final Component applicationComponent) {
		//TODO del		super(applicationComponent);  //construct the parent
		this(applicationComponent, true); //construct and initialize the panel
	}

	/**
	 * Constructor that allows options to be set, such as the presence of a status bar.
	 * @param hasToolBar Whether this panel should have a toolbar.
	 * @param hasStatusBar Whether this panel should have a status bar.
	 */
	public AbstractMDIDocumentPanel(final boolean hasToolBar, final boolean hasStatusBar) {
		this(hasToolBar, hasStatusBar, true); //do the default construction
	}

	/**
	 * Constructor that allows options to be set, such as the presence of a status bar.
	 * @param hasToolBar Whether this panel should have a toolbar.
	 * @param hasStatusBar Whether this panel should have a status bar.
	 * @param initialize true if the panel should initialize itself by calling the initialization methods.
	 */
	protected AbstractMDIDocumentPanel(final boolean hasToolBar, final boolean hasStatusBar, final boolean initialize) {
		super(hasToolBar, hasStatusBar, false); //construct the parent, but don't initialize it, yet
		/*TODO del when works		
				rdf=new RDF();  //TODO testing; comment
				resource=createDefaultResource(); //create the default resource used for describing the document
		*/
		//TODO del		description=new DefaultDocumentDescription();	//create a new document description
		if(initialize) //if we should initialize
			initialize(); //initialize the panel
	}

	/**
	 * Creates any application objects and initializes data. Any class that overrides this method must call this version.
	 */
	/*TODO del
		protected void initializeData()
		{
			super.initializeData(); //do the default data initialization
			rdf=new RDF();  //TODO testing; comment
			resource=createDefaultResource(); //create the default resource used for describing the document
		}
	*/

	/**
	 * Creates the default resource used for describing the document.
	 * @return A resource for describing the document.
	 */
	/*TODO del when works	
		protected RDFResource createDefaultResource()
		{
			return getRDF().createResource();  //create a default resource
		}
	*/

	/**
	 * Loads the resource by reading the contents of the resource from the given input stream. Convenience implementation to read with no description.
	 * @param inputStream The source of the content.
	 * @throws IOException Thrown if there is an error reading the contents.
	 */
	public void read(final InputStream inputStream) throws IOException {
		//TODO fix		read(inputStream, null);	//read with no description
	}

}