/**
 *    FrameImage.java
 *    Copyright (C) 2010 New Zealand Digital Library, http://expeditee.org
 *
 *    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 <http://www.gnu.org/licenses/>.
 */

package org.expeditee.items;

import org.expeditee.core.Image;
import org.expeditee.gui.Frame;
import org.expeditee.gui.FrameGraphics;
import org.expeditee.gui.FrameIO;

public class FrameImage extends FramePicture {
	/**
	 * Creates a new Picture from the given path. The ImageObserver is optional
	 * and can be set to NULL. <br>
	 * Note: It is assumed that the file described in path has already been
	 * checked to exist.
	 * 
	 * @param source
	 *            The Text Item that was used to create this Picture
	 * @param path
	 *            The Path of the Image to load from disk.
	 * @param observer
	 *            The ImageObserver to assign when painting the Image on the
	 *            screen.
	 */
	public FrameImage(Text source, Image image) {
		super(source, image);
	}

	@Override
	protected Picture createPicture() {
		return new FrameImage(_source.copy(), _image);
	}

	@Override
	public boolean refresh() {
		// Need to parse the first time the frame is being displayed
		// parseSize();
		assert (_source.getLink() != null);
		Frame frame = FrameIO.LoadFrame(_source.getAbsoluteLink(), null, true);
		if (frame == null)
			return false;

		frame.setBuffer(FrameGraphics.getFrameImage(frame, null, null, false, false));
		_image = frame.getBuffer();

		// TODO tidy this up, need to call parse size only when the frame has
		// been created to begin with
		parseSize();
		invalidateBounds();
		return true;
	}

	@Override
	protected String getTagText() {
		return "@f: ";
	}
}