com.globalmentor.swing.text.xml.XMLComponentView 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.text.xml;

import java.awt.Component;
import javax.swing.text.*;

import com.globalmentor.log.Log;

/**
 * A view that displays a given component. The component must be created before this view is created, and this view merely stores the component until time for
 * its view "creation".
 * @author Garret Wilson
 */
public class XMLComponentView extends XMLAbstractComponentView {

	/** The already created component, which will be returned by the {@link #createComponent()} method. */
	private final Component precreatedComponent;

	/**
	 * Creates a new view that represents a component, supplying the component to display in the view.
	 * @param element The element for which to create the view.
	 */
	public XMLComponentView(final Element element, final Component component) {
		super(element); //do the default constructing
		Log.trace("Component width: ", component.getWidth()); //TODO del
		Log.trace("Component height: ", component.getHeight()); //TODO del
		Log.trace("Component preferred width: ", new Double(component.getPreferredSize().getWidth())); //TODO del
		Log.trace("Component preferred height: ", new Double(component.getPreferredSize().getHeight())); //TODO del
		setHeight(component.getPreferredSize().height); //update the standard and current heights TODO testing
		setWidth(component.getPreferredSize().width); //update the standard and current widths
		precreatedComponent = component; //store the precreated component
	}

	/**
	 * Creates a new component for this view to represent. Because this class requires a component to already be created before this view is created, this method
	 * really just returns the component that was already created.
	 * @return A component to display.
	 */
	protected Component createComponent() {
		//TODO del when works		  precreatedComponent.setSize(100, 50);  //TODO testing

		return precreatedComponent; //return the component we already created
	}

	/**
	 * Determines the maximum span for this view along an axis. This currently returns the permanent size of the object, initialized by setWidth()
	 * and setHeight().
	 * @param axis The axis, either X_AXIS or Y_AXIS.
	 * @returns The maximum span the view can be rendered into.
	 * @throws IllegalArgumentException Thrown if the axis is not recognized.
	 * @see View#getPreferredSpan
	 * @see #getHeight
	 * @see #getWidth
	 */
	public float getMinimumSpan(int axis) { //TODO testing
		//TODO fix all this with the ability to fix certain axes in the parent class
		switch(axis) { //see which axis we're looking at
			case View.X_AXIS: //if the x-axis is requested
				return getWidth(); //return the width of the object as the maximum width
			case View.Y_AXIS: //if the y-axis is requested
				return getHeight(); //return the height of the object as the maximum height
			default: //if we don't recognize the axis
				throw new IllegalArgumentException("Invalid axis: " + axis); //report that we don't recognize the axis
		}
	}

}