IlvDisplayPreferences (Rogue Wave JViews 9.1 API)

java.lang.Object
- ilog.views.maps.IlvDisplayPreferences

All Implemented Interfaces:

IlvPersistentObject
```
public class IlvDisplayPreferences
extends Object
implements IlvPersistentObject
```
This class defines the methods needed to display preferences (units, formats) for an IlvManager containing cartographic data. Display preferences include :
- The units to use when displaying distances
- The units to use when displaying altitudes
- The IlvCoordinateFormatter use when displaying coordinates
- An indication to use geodetic computation and date line warping when rendering polygons
It is also possible to provide your own altitude and distance formats if the default ones, based on unit abbreviations, are not adequate.
Also, IlvDisplayPreferences provides many utility methods to format coordinates, altitudes and distances anywhere in an application.
Since:

JViews 7.5

Constructor Summary

Constructors
Constructor and Description
`IlvDisplayPreferences()` Creates a new `IlvDisplayPreferences`.
`IlvDisplayPreferences(IlvDisplayPreferences preferences)` Creates a new `IlvDisplayPreferences` by copying an existing one.
`IlvDisplayPreferences(IlvInputStream stream)` Creates a new `IlvDisplayPreferences` from an `IlvInputStream`.
`IlvDisplayPreferences(IlvLinearUnit distanceUnit, IlvLinearUnit altitudeUnit)` Creates a new `IlvDisplayPreferences`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`IlvDisplayPreferences`	`copy()` Creates a new `IlvAltitudeProvider` from an `IlvDefaultAltitudeProvider`.
`boolean`	`equals(Object other)` Overrides deep comparison equals.
`String`	`formatAltitude(double alt)` Transforms and formats an altitude (in meters).
`String`	`formatAngle(double angleRad)` Transforms an angle in radians using the current coordinate formatter.
`String`	`formatCoordinates(double xlon, double ylat)` Formats lat/lon coordinates in radians according to the preferred formatter.
`String`	`formatDistance(double dist)` Transforms and formats a distance (in meter) .
`DecimalFormat`	`getAltitudeFormater()` Returns the altitude Formatter.
`IlvLinearUnit`	`getAltitudeUnit()` Returns the altitude Unit.
`IlvCoordinateFormatter`	`getCoordinateFormatter()` Returns the coordinate Formatter.
`DecimalFormat`	`getDistanceFormater()` Returns the distance Formatter.
`IlvLinearUnit`	`getDistanceUnit()` Returns the distance Unit.
`boolean`	`isUsingGeodeticComputation()` Returns the `usingGeodeticComputation`.
`void`	`setAltitudeFormat(String altitudeFormat)` Sets the format to use when formatting altitudes.
`void`	`setAltitudeUnit(IlvLinearUnit altitudeUnit, boolean resetFormat)` Sets the altitude unit and possibly the altitude format.
`void`	`setCoordinateFormatter(IlvCoordinateFormatter coordinateFormatter)` Sets the coordinate formatter to use when displaying coordinates.
`void`	`setDistanceFormat(String distanceFormat)` Sets the format to use when formatting distance.
`void`	`setDistanceUnit(IlvLinearUnit distanceUnit, boolean resetFormat)` Sets the distance unit and possibly the distance format.
`void`	`setUsingGeodeticComputation(boolean usingGeodeticComputation)` Indicates whether or not the map should use geodetic computation (date line wrapping).
`void`	`write(IlvOutputStream stream)` Writes the preferences to the output stream.

Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - IlvDisplayPreferences
```
public IlvDisplayPreferences()
```
    Creates a new IlvDisplayPreferences. Default units are meters.
    
    See Also:
    
    IlvDisplayPreferences(IlvLinearUnit, IlvLinearUnit)
  - IlvDisplayPreferences
```
public IlvDisplayPreferences(IlvDisplayPreferences preferences)
```
    Creates a new IlvDisplayPreferences by copying an existing one.
    
    Parameters:
    
    preferences - The source preferences to be copied.
  - IlvDisplayPreferences
```
public IlvDisplayPreferences(IlvInputStream stream)
                      throws IlvReadFileException
```
    Creates a new IlvDisplayPreferences from an IlvInputStream.
    
    Parameters:
    
    stream - The input stream.
    
    Throws:
    
    IlvReadFileException - if an error occurs while reading.
  - IlvDisplayPreferences
```
public IlvDisplayPreferences(IlvLinearUnit distanceUnit,
                             IlvLinearUnit altitudeUnit)
```
    Creates a new IlvDisplayPreferences. Default altitude and distance formats will be "###,### [unit abbreviation]". The default coordinate formatter is IlvDMSCoordinateFormatter.
    
    Parameters:
    
    distanceUnit - Unit to use to display distances.
    
    altitudeUnit - Unit to use to display altitudes.
- Method Detail
  - copy
```
public IlvDisplayPreferences copy()
```
    Creates a new IlvAltitudeProvider from an IlvDefaultAltitudeProvider.
    
    Returns:
    
    A new IlvAltitudeProvider.
  - formatAltitude
```
public String formatAltitude(double alt)
```
    Transforms and formats an altitude (in meters).
    
    Parameters:
    
    alt - Altitude in meters.
    
    Returns:
    
    The formated altitude.
    
    See Also:
    
    getAltitudeUnit(), getAltitudeFormater()
  - formatCoordinates
```
public String formatCoordinates(double xlon,
                                double ylat)
```
    Formats lat/lon coordinates in radians according to the preferred formatter.
    
    Parameters:
    
    xlon - Longitude in radians.
    
    ylat - Latitude in radians.
    
    Returns:
    
    The formated String.
    
    See Also:
    
    getCoordinateFormatter()
  - formatDistance
```
public String formatDistance(double dist)
```
    Transforms and formats a distance (in meter) .
    
    Parameters:
    
    dist - Distance in meters.
    
    Returns:
    
    The formated distance.
    
    See Also:
    
    getDistanceUnit(), getDistanceFormater()
  - getAltitudeFormater
```
public DecimalFormat getAltitudeFormater()
```
    Returns the altitude Formatter.
    
    Returns:
    
    Returns the altitude Formatter.
  - getAltitudeUnit
```
public IlvLinearUnit getAltitudeUnit()
```
    Returns the altitude Unit.
    
    Returns:
    
    Returns the altitude Unit.
  - getCoordinateFormatter
```
public IlvCoordinateFormatter getCoordinateFormatter()
```
    Returns the coordinate Formatter.
    
    Returns:
    
    Returns the coordinate Formatter.
  - getDistanceFormater
```
public DecimalFormat getDistanceFormater()
```
    Returns the distance Formatter.
    
    Returns:
    
    Returns the distance Formatter.
  - getDistanceUnit
```
public IlvLinearUnit getDistanceUnit()
```
    Returns the distance Unit.
    
    Returns:
    
    Returns the distance Unit.
  - setAltitudeFormat
```
public void setAltitudeFormat(String altitudeFormat)
```
    Sets the format to use when formatting altitudes.
    
    Parameters:
    
    altitudeFormat - The altitude format pattern to set.
    
    See Also:
    
    DecimalFormat.DecimalFormat(java.lang.String)
  - setAltitudeUnit
```
public void setAltitudeUnit(IlvLinearUnit altitudeUnit,
                            boolean resetFormat)
```
    Sets the altitude unit and possibly the altitude format.
    
    Parameters:
    
    altitudeUnit - The altitude Unit to set.
    
    resetFormat - If true, altitude format will be reset to "###,### [unit abbreviation]".
  - setCoordinateFormatter
```
public void setCoordinateFormatter(IlvCoordinateFormatter coordinateFormatter)
```
    Sets the coordinate formatter to use when displaying coordinates.
    
    Parameters:
    
    coordinateFormatter - The coordinate formatter to use.
  - setDistanceFormat
```
public void setDistanceFormat(String distanceFormat)
```
    Sets the format to use when formatting distance.
    
    Parameters:
    
    distanceFormat - The distance format pattern to set.
    
    See Also:
    
    DecimalFormat.DecimalFormat(java.lang.String)
  - setDistanceUnit
```
public void setDistanceUnit(IlvLinearUnit distanceUnit,
                            boolean resetFormat)
```
    Sets the distance unit and possibly the distance format.
    
    Parameters:
    
    distanceUnit - The distance Unit to set.
    
    resetFormat - If true, distance format will be reset to "###,### [unit abbreviation]".
  - write
```
public void write(IlvOutputStream stream)
           throws IOException
```
    Writes the preferences to the output stream.
    
    Specified by:
    
    write in interface IlvPersistentObject
    
    Parameters:
    
    stream - the output stream
    
    Throws:
    
    IOException - thrown when an exception occurs during the write operation for this object.
    
    See Also:
    
    IlvPersistentObject.write(ilog.views.io.IlvOutputStream)
  - formatAngle
```
public String formatAngle(double angleRad)
```
    Transforms an angle in radians using the current coordinate formatter. NOTE: if the current coordinate formatter does not support angles, a IlvDMSCoordinateFormatter will be used instead.
    
    Parameters:
    
    angleRad - Angle in radians.
    
    Returns:
    
    A String containing the angle formatted with current parameters.
    
    See Also:
    
    IlvCoordinateFormatter.getAngleString(double)
  - isUsingGeodeticComputation
```
public boolean isUsingGeodeticComputation()
```
    Returns the usingGeodeticComputation.
    
    Returns:
    
    Returns the usingGeodeticComputation.
  - setUsingGeodeticComputation
```
public void setUsingGeodeticComputation(boolean usingGeodeticComputation)
```
    Indicates whether or not the map should use geodetic computation (date line wrapping).
    
    Parameters:
    
    usingGeodeticComputation - true is geodetic computation is used.
  - equals
```
public boolean equals(Object other)
```
    Overrides deep comparison equals.
    
    Overrides:
    
    equals in class Object
    
    See Also:
    
    Object.equals(java.lang.Object)

Class IlvDisplayPreferences

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

IlvDisplayPreferences

IlvDisplayPreferences

IlvDisplayPreferences

IlvDisplayPreferences

Method Detail

copy

formatAltitude

formatCoordinates

formatDistance

getAltitudeFormater

getAltitudeUnit

getCoordinateFormatter

getDistanceFormater

getDistanceUnit

setAltitudeFormat

setAltitudeUnit

setCoordinateFormatter

setDistanceFormat

setDistanceUnit

write

formatAngle

isUsingGeodeticComputation

setUsingGeodeticComputation

equals