Java Doc for TextSymbolizer.java in » GIS » GeoTools-2.4.1 » org » geotools » styling » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » GIS » GeoTools 2.4.1 » org.geotools.styling

Source Cross Reference Class Diagram Java Document (Java Doc)

org.geotools.styling .TextSymbolizer

TextSymbolizer

public interface TextSymbolizer extends Symbolizer(Code)

A symbolizer describes how a feature should appear on a map.

A symbolizer is obtained by specifying one of a small number of different types of symbolizer and then supplying parameters to override its default behaviour.

The text symbolizer describes how to display text labels and the like.

The details of this object are taken from the OGC Styled-Layer Descriptor Report (OGC 02-070) version 1.0.0.:


 <xsd:element name="TextSymbolizer" substitutionGroup="sld:Symbolizer">
 <xsd:annotation>
 <xsd:documentation>
 A "TextSymbolizer" is used to render text labels according to
 various graphical parameters.
 </xsd:documentation>
 </xsd:annotation>
 <xsd:complexType>
 <xsd:complexContent>
 <xsd:extension base="sld:SymbolizerType">
 <xsd:sequence>
 <xsd:element ref="sld:Geometry" minOccurs="0"/>
 <xsd:element ref="sld:Label" minOccurs="0"/>
 <xsd:element ref="sld:Font" minOccurs="0"/>
 <xsd:element ref="sld:LabelPlacement" minOccurs="0"/>
 <xsd:element ref="sld:Halo" minOccurs="0"/>
 <xsd:element ref="sld:Fill" minOccurs="0"/>
 </xsd:sequence>
 </xsd:extension>
 </xsd:complexContent>
 </xsd:complexType>
 </xsd:element>

Renderers can use this information when displaying styled features, though it must be remembered that not all renderers will be able to fully represent strokes as set out by this interface. For example, opacity may not be supported.

Notes:

The graphical parameters and their values are derived from SVG/CSS2 standards with names and semantics which are as close as possible.

$Id: TextSymbolizer.java 25459 2007-05-08 05:19:25Z jgarnett $
author:
Ian Turton, CCG

Method Summary
void	addToOptions(String key, String value)
Fill	getFill() Returns the object that indicates how the text will be filled.
Font[]	getFonts() Returns a device independent Font object that is to be used to render the label.
String	getGeometryPropertyName() This property defines the geometry to be used for styling. The property is optional and if it is absent (null) then the "default" geometry property of the feature should be used.
Halo	getHalo() A halo fills an extended area outside the glyphs of a rendered text label to make the label easier to read over a background.
Expression	getLabel() Returns the expression that will be evaluated to determine what text is displayed.
LabelPlacement	getLabelPlacement() A LabelPlacement specifies how a text element should be rendered relative to its geometric point or line.
String	getOption(String key)
Map	getOptions()
LabelPlacement	getPlacement() A LabelPlacement specifies how a text element should be rendered relative to its geometric point or line.
Expression	getPriority() Priority -- null = use the default labeling priority Expression = an expression that evaluates to a number (ie.
void	setFill(Fill fill) Sets the object that indicates how the text will be filled.
void	setFonts(Font[] fonts) sets a list of device independent Font objects to be used to render the label.
void	setGeometryPropertyName(String name) This property defines the geometry to be used for styling. The property is optional and if it is absent (null) then the "default" geometry property of the feature should be used.
void	setHalo(Halo halo) A halo fills an extended area outside the glyphs of a rendered text label to make the label easier to read over a background.
void	setLabel(Expression label) Sets the expression that will be evaluated to determine what text is displayed.
void	setLabelPlacement(LabelPlacement labelPlacement) A LabelPlacement specifies how a text element should be rendered relative to its geometric point or line.
void	setPlacement(LabelPlacement labelPlacement) A LabelPlacement specifies how a text element should be rendered relative to its geometric point or line.
void	setPriority(Expression e) Priority -- null = use the default labeling priority Expression = an expression that evaluates to a number (ie.

Method Detail

addToOptions
void addToOptions(String key, String value)(Code)
	adds a parameter value to the options map Parameters: key - Parameters: value -

getFill
Fill getFill()(Code)
	Returns the object that indicates how the text will be filled. DOCUMENT ME!

getFonts
Font[] getFonts()(Code)
	Returns a device independent Font object that is to be used to render the label. DOCUMENT ME!

getGeometryPropertyName
String getGeometryPropertyName()(Code)
	This property defines the geometry to be used for styling. The property is optional and if it is absent (null) then the "default" geometry property of the feature should be used. Geometry types other than inherently point types can be used. The geometryPropertyName is the name of a geometry property in the Feature being styled. Typically, features only have one geometry so, in general, the need to select one is not required. Note: this moves a little away from the SLD spec which provides an XPath reference to a Geometry object, but does follow it in spirit. The name of the attribute in the feature being styled thatshould be used. If null then the default geometry should beused.

getHalo
Halo getHalo()(Code)
	A halo fills an extended area outside the glyphs of a rendered text label to make the label easier to read over a background. DOCUMENT ME!

getLabel
Expression getLabel()(Code)
	Returns the expression that will be evaluated to determine what text is displayed. DOCUMENT ME!

getLabelPlacement
LabelPlacement getLabelPlacement()(Code)
	A LabelPlacement specifies how a text element should be rendered relative to its geometric point or line. DOCUMENT ME!

getOption
String getOption(String key)(Code)
	Find the value of a key in the map (may return null) Parameters: key -

getOptions
Map getOptions()(Code)
	return the map of option null - no options set

getPlacement
LabelPlacement getPlacement()(Code)
	A LabelPlacement specifies how a text element should be rendered relative to its geometric point or line. DOCUMENT ME! since: Geotools 2.2 (GeoAPI 2.0)

getPriority
Expression getPriority()(Code)
	Priority -- null = use the default labeling priority Expression = an expression that evaluates to a number (ie. Integer, Long, Double...) Larger = more likely to be rendered DOCUMENT ME!

setFill
void setFill(Fill fill)(Code)
	Sets the object that indicates how the text will be filled. See TextSymbolizer.getFill for details. Parameters: fill - DOCUMENT ME!

setFonts
void setFonts(Font[] fonts)(Code)
	sets a list of device independent Font objects to be used to render the label. Parameters: fonts - DOCUMENT ME!

setGeometryPropertyName
void setGeometryPropertyName(String name)(Code)
	This property defines the geometry to be used for styling. The property is optional and if it is absent (null) then the "default" geometry property of the feature should be used. Geometry types other than inherently point types can be used. The geometryPropertyName is the name of a geometry property in the Feature being styled. Typically, features only have one geometry so, in general, the need to select one is not required. Note: this moves a little away from the SLD spec which provides an XPath reference to a Geometry object, but does follow it in spirit. Parameters: name - The name of the attribute in the feature being styled thatshould be used. If null then the default geometry should beused.

setHalo
void setHalo(Halo halo)(Code)
	A halo fills an extended area outside the glyphs of a rendered text label to make the label easier to read over a background. Parameters: halo - DOCUMENT ME!

setLabel
void setLabel(Expression label)(Code)
	Sets the expression that will be evaluated to determine what text is displayed. See TextSymbolizer.getLabel for details. Parameters: label - DOCUMENT ME!

setLabelPlacement
void setLabelPlacement(LabelPlacement labelPlacement)(Code)
	A LabelPlacement specifies how a text element should be rendered relative to its geometric point or line. Parameters: labelPlacement - DOCUMENT ME!

setPlacement
void setPlacement(LabelPlacement labelPlacement)(Code)
	A LabelPlacement specifies how a text element should be rendered relative to its geometric point or line. Parameters: labelPlacement - DOCUMENT ME!

setPriority
void setPriority(Expression e)(Code)
	Priority -- null = use the default labeling priority Expression = an expression that evaluates to a number (ie. Integer, Long, Double...) Larger = more likely to be rendered Parameters: e -

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.