/*---------------- FILE HEADER ------------------------------------------
This file is part of deegree.
Copyright (C) 2001-2006 by:
EXSE, Department of Geography, University of Bonn
http://www.giub.uni-bonn.de/deegree/
lat/lon GmbH
http://www.lat-lon.de
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.
This library 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
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
Contact:
Andreas Poth
lat/lon GmbH
Aennchenstr. 19
53115 Bonn
Germany
E-Mail: poth@lat-lon.de
Prof. Dr. Klaus Greve
Department of Geography
University of Bonn
Meckenheimer Allee 166
53115 Bonn
Germany
E-Mail: greve@giub.uni-bonn.de
---------------------------------------------------------------------------*/
package org.deegree.graphics.sld;
import org.deegree.framework.xml.Marshallable;
/**
* Used to position a label relative to a point or a line string. For a point,
* you can specify the anchor point of the label and a linear displacement from
* the point (so that you can also plot a graphic symbol at the point). For a
* line-string placement, you can specify a perpendicular offset (so you can draw
* a stroke on the line). MORE PARAMETERS ARE PROBABLY NEEDED HERE.
* <p>
* @author <a href="mailto:k.lupp@web.de">Katharina Lupp</a>
* @author <a href="mailto:mschneider@lat-lon.de">Markus Schneider</a>
* @version $Revision: 1.8 $ $Date: 2006/07/29 08:51:12 $
*/
public class LabelPlacement implements Marshallable {
private LinePlacement linePlacement = null;
private PointPlacement pointPlacement = null;
/**
* constructor initializing the class with the <LabelPlacement>
*/
public LabelPlacement( PointPlacement pointPlacement ) {
setPointPlacement( pointPlacement );
}
/**
* constructor initializing the class with the <LabelPlacement>
*/
public LabelPlacement( LinePlacement linePlacement ) {
setLinePlacement( linePlacement );
}
/**
* For a PointPlacement, the anchor point of the label and a linear
* displacement from the point can be specified, to allow a graphic symbol
* to be plotted directly at the point. This might be useful to label a city,
* for example.
* @return the pointplacement for the label
*
*/
public PointPlacement getPointPlacement() {
return pointPlacement;
}
/**
* sets <PointPlacement>
* @param pointPlacement the pointplacement for the label
*
*/
public void setPointPlacement(PointPlacement pointPlacement) {
this.pointPlacement = pointPlacement;
linePlacement = null;
}
/**
* For a LinePlacement, a perpendicular offset can be specified,
* to allow the line itself to be plotted also. This might be useful for
* labelling a road or a river, for example.
* @return the lineplacement for the label
*
*/
public LinePlacement getLinePlacement() {
return linePlacement;
}
/**
* sets <LinePlacement>
* @param linePlacement the lineplacement for the label
*
*/
public void setLinePlacement(LinePlacement linePlacement) {
this.linePlacement = linePlacement;
pointPlacement = null;
}
/**
* exports the content of the Font as XML formated String
*
* @return xml representation of the Font
*/
public String exportAsXML() {
StringBuffer sb = new StringBuffer(1000);
sb.append( "<LabelPlacement>" );
if ( pointPlacement != null ) {
sb.append( ((Marshallable)pointPlacement).exportAsXML() );
} else if ( linePlacement != null ) {
sb.append( ((Marshallable)linePlacement).exportAsXML() );
}
sb.append( "</LabelPlacement>" );
return sb.toString();
}
}
/* ********************************************************************
Changes to this class. What the people have been up to:
$Log: LabelPlacement.java,v $
Revision 1.8 2006/07/29 08:51:12 poth
references to deprecated classes removed
Revision 1.7 2006/07/12 14:46:14 poth
comment footer added
********************************************************************** */