org.openbp.cockpit.modeler.figures.generic.MoveableTitleFigure Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of openbp-cockpit Show documentation
OpenBP Cockpit (graphical process modeler)
The newest version!
/*
 *   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 org.openbp.cockpit.modeler.figures.generic;

import org.openbp.cockpit.modeler.util.FigureUtil;
import org.openbp.common.generic.description.DisplayObject;

import CH.ifa.draw.figures.TextFigure;

/**
 * Moveable text figure that is connected to a given display object (the client) and displays
 * either the name or the display text of the object.
 * The figure extends the default JHotDraw text figure, thus supporting figure movement and resizing.
 *
 * @author Stephan Moritz
 */
public class MoveableTitleFigure extends TextFigure
	implements TitleFigure
{
	/** The display object we are connected with */
	private DisplayObject client;

	/** Title format */
	private String titleFormat;

	/** Flag if the display text or the object name should be displayed if there is no display name of the client object */
	private boolean verboseDisplay;

	/**
	 * Constructor.
	 */
	public MoveableTitleFigure()
	{
		this(null);
	}

	/**
	 * Constructor.
	 *
	 * @param client The display object we are connected with
	 */
	public MoveableTitleFigure(DisplayObject client)
	{
		super();

		setClient(client);
	}

	//////////////////////////////////////////////////
	// @@ UpdatableFigure implementation
	//////////////////////////////////////////////////

	public void updateFigure()
	{
		FigureUtil.synchronizeText(this);
	}

	//////////////////////////////////////////////////
	// @@ TitleFigure implementation
	//////////////////////////////////////////////////

	public DisplayObject getClient()
	{
		return client;
	}

	public void setClient(DisplayObject client)
	{
		this.client = client;

		updateFigure();
	}

	public String getTitleFormat()
	{
		return titleFormat;
	}

	public void setTitleFormat(String titleFormat)
	{
		this.titleFormat = titleFormat;
	}

	public boolean isVerboseDisplay()
	{
		return verboseDisplay;
	}

	public void setVerboseDisplay(boolean verboseDisplay)
	{
		if (this.verboseDisplay != verboseDisplay)
		{
			this.verboseDisplay = verboseDisplay;
			updateFigure();
		}
	}
}