/*******************************************************************************
* Copyright (c) 2006-2012
* Software Technology Group, Dresden University of Technology
* DevBoost GmbH, Berlin, Amtsgericht Charlottenburg, HRB 140026
*
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* Software Technology Group - TU Dresden, Germany;
* DevBoost GmbH - Berlin, Germany
* - initial API and implementation
******************************************************************************/
/*
* @(#)TextHolderFigure.java 1.1 2007-05-19
*
* Copyright (c) 1996-2007 by the original authors of JHotDraw
* and all its contributors.
* All rights reserved.
*
* The copyright of this software is owned by the authors and
* contributors of the JHotDraw project ("the copyright holders").
* You may not use, copy or modify this software, except in
* accordance with the license agreement you entered into with
* the copyright holders. For details see accompanying license terms.
*/
package org.jhotdraw.draw;
import org.jhotdraw.util.*;
import java.awt.*;
import org.jhotdraw.geom.*;
/**
* The interface of a figure that has some editable text contents.
*
* @author Werner Randelshofer
* @version 2.1 2007-05-19 Added method isTextOverflow.
* <br>2.0 2006-01-14 Changed to support double precison coordinates.
* <br>1.0 2003-12-01 Derived from JHotDraw 5.4b1.
*/
public interface TextHolderFigure extends Figure {
// FIXME - Maybe we can remove method isEditable(), because we already have
// an isInteractive() method in the Figure interface.
/**
* Returns true if the text of the TextHolderFigure can be edited.
*/
public boolean isEditable();
/**
* Returns the font to be used by a text editor for editing this Figure.
*/
public Font getFont();
/**
* Returns the text color to be used by a text editor for editing this Figure.
*/
public Color getTextColor();
/**
* Returns the fill color to be used by a text editor for editing this Figure.
*/
public Color getFillColor();
// FIMXE - Maybe we can remove method getLabelFor().
/**
* Sometimes we want to use a TextHolderFigure as a label for another
* TextHolderFigure. Returns the TextHolderFigure that should be really used.
*/
public TextHolderFigure getLabelFor();
/**
* Gets the number of characters used to expand tabs.
*/
public int getTabSize();
// FIMXE - Maybe method getText and setText should work with StyledDocument
// instead of with Strings.
/**
* Returns the text held by the Text Holder.
*/
public String getText();
/**
* Sets the text of the Text Holder.
* @param text
*/
public void setText(String text);
/**
* Gets the number of columns to be overlaid when the figure is edited.
*/
public int getTextColumns();
/**
* Sets the font size of the text held by the TextHolderFigure.
*/
public void setFontSize(float size);
/**
* Gets the font size of the text held by the TextHolderFigure.
*/
public float getFontSize();
/**
* Gets the baseline of the first line of text, relative to the
* upper left corner of the figure bounds.
*/
public double getBaseline();
/**
* Returns Insets to be used by the text editor relative to the handle bounds
* of the figure.
*/
public Insets2D.Double getInsets();
/**
* Returns true, if the text does not fit into the bounds of the Figure.
*/
public boolean isTextOverflow();
}