org.geotools.styling
Interface Style

All Known Subinterfaces:
NamedStyle
All Known Implementing Classes:
BasicLineStyle, BasicPolygonStyle, NamedStyleImpl, StyleImpl

public interface Style

Indicates how geographical content should be displayed (we call this a style for simplicity; in the spec it is called a UserStyle (user-defined style)).

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


 <xsd:element name="UserStyle">
   <xsd:annotation>
     <xsd:documentation>
       A UserStyle allows user-defined styling and is semantically
       equivalent to a WMS named style.
     </xsd:documentation>
   </xsd:annotation>
   <xsd:complexType>
     <xsd:sequence>
       <xsd:element ref="sld:Name" minOccurs="0"/>
       <xsd:element ref="sld:Title" minOccurs="0"/>
       <xsd:element ref="sld:Abstract" minOccurs="0"/>
       <xsd:element ref="sld:IsDefault" minOccurs="0"/>
       <xsd:element ref="sld:FeatureTypeStyle" maxOccurs="unbounded"/>
     </xsd:sequence>
   </xsd:complexType>
 </xsd:element>
 

Author:
James Macgill
Module:

Method Summary
 void accept(StyleVisitor visitor)
          Used to navigate Style information during portrayal.
 void addFeatureTypeStyle(FeatureTypeStyle type)
          Deprecated. replaced by a live list in 2.6.x
 String getAbstract()
          Deprecated. use getDesciption().getAbstract().toString()
 Description getDescription()
          Description for this style.
 FeatureTypeStyle[] getFeatureTypeStyles()
          Deprecated. replaced by a live list in 2.6.x
 String getName()
          Style name (machine readable, don't show to users)
 String getTitle()
          Deprecated. use getDescription().getTitle().toString()
 boolean isDefault()
          Indicates that this is the default style.
 void setAbstract(String abstractStr)
          Deprecated. 
 void setDefault(boolean isDefault)
          Indicates that this is the default style.
 void setFeatureTypeStyles(FeatureTypeStyle[] types)
          Deprecated. replaced by a live list in 2.6.x
 void setName(String name)
           
 void setTitle(String title)
          Deprecated. please use getDescription().setTitle
 

Method Detail

getName

String getName()
Style name (machine readable, don't show to users)


setName

void setName(String name)

getDescription

Description getDescription()
Description for this style.

Returns:
Human readable description for use in user interfaces
Since:
2.5.x

getTitle

String getTitle()
Deprecated. use getDescription().getTitle().toString()

Style Title (human readable name for user interfaces)


setTitle

void setTitle(String title)
Deprecated. please use getDescription().setTitle

Parameters:
title -

getAbstract

String getAbstract()
Deprecated. use getDesciption().getAbstract().toString()

Description of this style


setAbstract

@Deprecated
void setAbstract(String abstractStr)
Deprecated. 


isDefault

boolean isDefault()
Indicates that this is the default style.


setDefault

void setDefault(boolean isDefault)
Indicates that this is the default style.

Assume this is kept for GeoServer enabling a WMS to track which style is considered the default. May consider providing a clientProperties mechanism similar to Swing JComponent allowing applications to mark up the Style content for custom uses.

Parameters:
isDefault -

getFeatureTypeStyles

@Deprecated
FeatureTypeStyle[] getFeatureTypeStyles()
Deprecated. replaced by a live list in 2.6.x

Array of FeatureTypeStyles in portrayal order.

FeatureTypeStyle entries are rendered in order of appearance in this list.

Note: We are using a Array here to continue with Java 1.4 deployment.


setFeatureTypeStyles

@Deprecated
void setFeatureTypeStyles(FeatureTypeStyle[] types)
Deprecated. replaced by a live list in 2.6.x


addFeatureTypeStyle

@Deprecated
void addFeatureTypeStyle(FeatureTypeStyle type)
Deprecated. replaced by a live list in 2.6.x


accept

void accept(StyleVisitor visitor)
Used to navigate Style information during portrayal.

Parameters:
visitor -


Copyright © 1996-2009 Geotools. All Rights Reserved.