ilog.views.maps

Class IlvMapCSSRenderer

java.lang.Object

ilog.views.maps.IlvDefaultFeatureRenderer

ilog.views.maps.IlvMapCSSRenderer

All Implemented Interfaces:

IlvPersistentObject, IlvFeatureRenderer, IlvStylable, Serializable

public class IlvMapCSSRenderer
extends IlvDefaultFeatureRenderer
implements IlvStylable

The Cascading Style Sheet (CSS) renderer is a renderer able to customize another renderer, or able to create a renderer using a CSS file. The CSS renderer is a default renderer so that it can take any type of geometry to produce the corresponding IlvGraphic. The renderers to customize must use setters and getters conform to the JavaBean specification style.
An IlvMapCSSRenderer is constructed with a type argument which indicates the type entry in the CSS file for which the renderer will take its customization parameters.

 airports {
      markerColor : red;
      markerSize : 10;
      markerType : "Cross|Circle";
 }
 

If the renderer was constructed with airports as type, it will take the markerColor, markerSize, markerType as customization parameters.

When a non-null renderer is specified at construction time, it will be customized and used to produce the IlvGraphic.
If a null renderer is passed, the CSS file can contain the class of the renderer to be used for a given type by using a special class key:

 cities {
      class : "ilog.views.maps.labelling.IlvLabeledPointRenderer";
      attributeNames : NAME,txt;
      rejectedValues : UNK;     
      pointRenderingStyle : @=citiesPoint;
      textRenderingStyle : @=citiesLabel;
 }
 

In this case, the cities theme will be rendered by an IlvLabeledPointRenderer, whose customization parameters are attributeNames, rejectedValues ... citiesPoint, and citiesLabel are nodes defined elsewhere in the CSS.

If a null renderer is passed and no renderer is defined in the CSS file, then the IlvMapCSSRenderer will act as an IlvDefaultFeatureRenderer. Attributes can also be part of the selector. You can either check the existence of an attribute, or check the value of attribute. Obviously, this behavior is possible only if the IlvMapFeature contains attributes.

 roads[FEATURE~="Principal"] {
        attributes : @=principalRoadsAttributes;
 }
 

If the FEATURE attribute contains the string "principal", the node will be matched.

Classes can also be in the selector. Classes recognized by the renderer are the maps geometry classes.

 .IlvMapPolygon {
      usingGeneralPath : true;
 }
 

All the geometries of class IlvMapPolygon will be rendered with a general path.

Since:

JViews 5.5

See Also:

Serialized Form

Field Summary

Fields inherited from interface ilog.views.util.styling.IlvStylable

APPLIED_RULE_MASK, BAD_CLASS_MASK, BAD_PROP_MASK, BAD_PROP_WITH_STACK_MASK, CREATED_MASK, DECL_MASK, DECL_VALUE_MASK, FAILED_CONVERSIONS_MASK, TIME_REPORT_MASK, WARNING_PROP_MASK

Constructor Summary

Constructors

Constructor and Description
IlvMapCSSRenderer(IlvFeatureRenderer renderer, String type, String[] styleSheets) Constructs an IlvMapCSSRenderer.
IlvMapCSSRenderer(IlvInputStream stream) Constructs an IlvMapCSSRenderer from an IlvInputStream.

Method Summary

Modifier and Type	Method and Description
void	addPropertyChangeListener(PropertyChangeListener listener) Adds the specified listener to receive PropertyChangeEvents from this CSS manager.
protected IlvGraphic	dispatch(IlvMapFeature feature, IlvCoordinateTransformation tr) Makes an IlvGraphic from a map feature.
String	getBaseTextDirection() Returns textual notation of the given base text direction
IlvFeatureRenderer	getCustomizedRenderer(IlvMapFeature feature) Returns the customized renderer for an IlvMapFeature instance.
String	getStyleSheet() Returns the value of the styleSheet property.
int	getStyleSheetDebugMask() Returns the current debug level.
String[]	getStyleSheets() Returns the cascaded style sheets.
String	getStyleSheets(int index) Returns one of the cascaded style sheets.
boolean	isPersistent() Returns true if the object must be saved.
IlvGraphic	makeGraphic(IlvMapFeature feature, IlvCoordinateTransformation tr) Makes an IlvGraphic from a map feature.
protected IlvGraphic	makeGraphicFromCollection(IlvMapFeature feature, IlvCoordinateTransformation tr) Makes an IlvGraphic from a map feature which contains a collection of geometries.
void	removePropertyChangeListener(PropertyChangeListener listener) Removes the specified listener so that it no longer receives PropertyChangeEvents from this CSS manager.
void	setBaseTextDirection(String textDirectionName) Changes the base direction of the text.
void	setStyleSheet(String styleSheet) Sets the value of the styleSheet property.
void	setStyleSheetDebugMask(int mask) Sets the debug flag while parsing the style sheets.
void	setStyleSheets(int index, String css) Changes one of the cascading style sheets.
void	setStyleSheets(String[] css) Sets the cascading style sheets.
void	write(IlvOutputStream stream) Writes the renderer to an IlvOutputStream.

Methods inherited from class ilog.views.maps.IlvDefaultFeatureRenderer

getAreaRenderer, getCurveRenderer, getImageRenderer, getMultiPointRenderer, getPointRenderer, getRasterRenderer, getTextRenderer, setAreaRenderer, setCurveRenderer, setImageRenderer, setMultiPointRenderer, setPointRenderer, setRasterRenderer, setTextRenderer

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IlvMapCSSRenderer

public IlvMapCSSRenderer(IlvFeatureRenderer renderer,
                         String type,
                         String[] styleSheets)
                  throws FileNotFoundException,
                         IOException,
                         IlvStylingException

Constructs an IlvMapCSSRenderer.

Parameters:

renderer - The renderer to customize, or null.

type - The type part of the selector.

styleSheets - The style sheets.

Throws:

FileNotFoundException

IOException

IlvStylingException

IlvMapCSSRenderer

public IlvMapCSSRenderer(IlvInputStream stream)
                  throws IlvReadFileException,
                         FileNotFoundException,
                         IOException,
                         IlvStylingException

Constructs an IlvMapCSSRenderer from an IlvInputStream.

Parameters:

stream - The IlvInputStream to read from.

Throws:

IlvReadFileException

FileNotFoundException

IOException

IlvStylingException

Method Detail

write

public void write(IlvOutputStream stream)
           throws IOException

Writes the renderer to an IlvOutputStream.

Specified by:

write in interface IlvPersistentObject

Specified by:

write in interface IlvFeatureRenderer

Overrides:

write in class IlvDefaultFeatureRenderer

Parameters:

stream - The IlvOutputStream to write to.

Throws:

IOException - thrown when an exception occurs during the write operation for this object.

dispatch

protected IlvGraphic dispatch(IlvMapFeature feature,
                              IlvCoordinateTransformation tr)
                       throws IlvCoordinateTransformationException,
                              IlvMapRenderException

Makes an IlvGraphic from a map feature. The renderer used to produce the IlvGraphic depends on the parameters passed at construction time (the style sheets, and so on). See general description for details. If no renderer has been specified, and no renderer has been defined in the CSS file, the IlvMapCSSRenderer acts as an IlvDefaultFeatureRenderer: This method dispatches calls to a specialized feature renderer depending on the geometry of the map feature. Each specialized feature renderer is initialized with a default value, but it can be changed. The specialized renderer is customized using the CSS file.

Overrides:

dispatch in class IlvDefaultFeatureRenderer

Parameters:

feature - The map feature to translate.

tr - The destination Coordinate System of the map feature.

Throws:

IlvMapRenderException - If the renderer cannot process the map feature.

IlvCoordinateTransformationException - If an error occurs during the coordinate transformation.

See Also:

IlvDefaultFeatureRenderer.setImageRenderer(ilog.views.maps.IlvFeatureRenderer), IlvDefaultFeatureRenderer.setAreaRenderer(ilog.views.maps.IlvFeatureRenderer), IlvDefaultFeatureRenderer.setCurveRenderer(ilog.views.maps.IlvFeatureRenderer), IlvDefaultFeatureRenderer.setMultiPointRenderer(ilog.views.maps.IlvFeatureRenderer), IlvDefaultFeatureRenderer.setPointRenderer(ilog.views.maps.IlvFeatureRenderer), IlvDefaultFeatureRenderer.setRasterRenderer(ilog.views.maps.IlvFeatureRenderer), IlvDefaultFeatureRenderer.setTextRenderer(ilog.views.maps.IlvFeatureRenderer)

getCustomizedRenderer

public IlvFeatureRenderer getCustomizedRenderer(IlvMapFeature feature)
                                         throws IlvMapRenderException

Returns the customized renderer for an IlvMapFeature instance.

Parameters:

feature - The map feature.

Returns:

A styled renderer that can be used for rendering map features without applying style sheets.

Throws:

IlvMapRenderException

Since:

JViews 6.0

makeGraphicFromCollection

protected IlvGraphic makeGraphicFromCollection(IlvMapFeature feature,
                                               IlvCoordinateTransformation tr)
                                        throws IlvCoordinateTransformationException,
                                               IlvMapRenderException

Makes an IlvGraphic from a map feature which contains a collection of geometries. This method calls dispatch(IlvMapFeature,IlvCoordinateTransformation).

Overrides:

makeGraphicFromCollection in class IlvDefaultFeatureRenderer

Parameters:

feature - The map feature to translate.

tr - The destination Coordinate System of the map feature.

Returns:

The created IlvGraphic.

Throws:

IlvMapRenderException - If the renderer cannot process the map feature.

IlvCoordinateTransformationException - If an error occurs during the coordinate transformation.

makeGraphic

public IlvGraphic makeGraphic(IlvMapFeature feature,
                              IlvCoordinateTransformation tr)
                       throws IlvMapRenderException,
                              IlvCoordinateTransformationException

Makes an IlvGraphic from a map feature. This method calls dispatch(IlvMapFeature,IlvCoordinateTransformation).

Specified by:

makeGraphic in interface IlvFeatureRenderer

Overrides:

makeGraphic in class IlvDefaultFeatureRenderer

Parameters:

feature - The map feature to translate.

tr - The destination Coordinate System of the map feature.

Throws:

IlvMapRenderException - If the renderer cannot process the map feature.

IlvCoordinateTransformationException - If an error occurs during the coordinate transformation.

isPersistent

public boolean isPersistent()

Returns true if the object must be saved.

Specified by:

isPersistent in interface IlvFeatureRenderer

Overrides:

isPersistent in class IlvDefaultFeatureRenderer

setStyleSheets

public void setStyleSheets(String[] css)
                    throws IlvStylingException

Sets the cascading style sheets. Each element can be a URL, a file name, or directly the style sheet string. The file/URL name can be relative name as IlvMapDataPathManager and is used to resolve the path or the URL. The order is by priority (the last CSS takes over).

Specified by:

setStyleSheets in interface IlvStylable

Parameters:

css - An array of strings containing the URLs, or the file names of CSS files (usually with a .css suffix). A null array is equivalent to specifying an empty style sheet.

Throws:

IlvStylingException - If an exception occurs while loading or parsing the style sheet.

See Also:

IlvMapDataPathManager

setStyleSheets

public void setStyleSheets(int index,
                           String css)
                    throws IlvStylingException

Changes one of the cascading style sheets. This method is an alternative to setStyleSheets(java.lang.String[]). It lets you change one particular style sheet file, instead of setting the whole style sheet array.

Specified by:

setStyleSheets in interface IlvStylable

Parameters:

index - The index of the style sheet to replace.

css - The URL or file name of the new style sheet file.

Throws:

IlvStylingException - If an exception occurs while loading or parsing the style sheet.

See Also:

setStyleSheets(java.lang.String[])

getStyleSheets

public String getStyleSheets(int index)

Returns one of the cascaded style sheets.

Specified by:

getStyleSheets in interface IlvStylable

Parameters:

index - The position of the cascading style sheet to return.

Returns:

The URL or file name of the index-th style sheet.

getStyleSheets

public String[] getStyleSheets()

Returns the cascaded style sheets.

Specified by:

getStyleSheets in interface IlvStylable

Returns:

An array containing the URLs or file names of the style sheets.

setStyleSheetDebugMask

public void setStyleSheetDebugMask(int mask)

Sets the debug flag while parsing the style sheets. Set this property before calling setStyleSheets(java.lang.String[]) to debug problems during the configuration. The default value traces bad class names and "setter" methods that raise an exception.

Specified by:

setStyleSheetDebugMask in interface IlvStylable

Parameters:

mask - The debug mask, expressed as an OR combination of the predefined masks.

See Also:

setStyleSheets(java.lang.String[]), getStyleSheetDebugMask(), IlvStylable.APPLIED_RULE_MASK, IlvStylable.BAD_CLASS_MASK, IlvStylable.BAD_PROP_MASK, IlvStylable.CREATED_MASK, IlvStylable.DECL_MASK, IlvStylable.DECL_VALUE_MASK, IlvStylable.FAILED_CONVERSIONS_MASK, IlvStylable.TIME_REPORT_MASK, IlvStylable.WARNING_PROP_MASK

getStyleSheetDebugMask

public int getStyleSheetDebugMask()

Returns the current debug level.

Specified by:

getStyleSheetDebugMask in interface IlvStylable

See Also:

setStyleSheetDebugMask(int)

setStyleSheet

public final void setStyleSheet(String styleSheet)
                         throws IlvStylingException

Sets the value of the styleSheet property. This method is equivalent to setStyleSheets(0, styleSheet).

Parameters:

styleSheet - The URL, the file name, or directly the style sheet string. This method overrides the first style sheet defined in setStyleSheets(String[]).

Throws:

IlvStylingException - If an exception occurs while loading or parsing the style sheet.

getStyleSheet

public final String getStyleSheet()

Returns the value of the styleSheet property. This method is equivalent to getStyleSheets(0).

Returns:

The styleSheet property, or the first of the cascading style sheets if setStyleSheets(String[]) was used.

See Also:

setStyleSheet(String)

setBaseTextDirection

public void setBaseTextDirection(String textDirectionName)

Changes the base direction of the text.

Since:

JViews 8.8

getBaseTextDirection

public String getBaseTextDirection()

Returns textual notation of the given base text direction

Returns:

Textual notation of the given base text direction

Since:

JViews 8.8

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener listener)

Adds the specified listener to receive PropertyChangeEvents from this CSS manager. A PropertyChangeEvent will be fired in response to setting a bound property, such as setStyleSheets(java.lang.String[]).

Specified by:

addPropertyChangeListener in interface IlvStylable

Parameters:

listener - The listener that will be subscribed to subsequent PropertyChangeEvents.

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener listener)

Removes the specified listener so that it no longer receives PropertyChangeEvents from this CSS manager.

Specified by:

removePropertyChangeListener in interface IlvStylable

Parameters:

listener - The listener that will be unsubscribed from receiving PropertyChangeEvents.