org.geomajas.configuration.client

Class ScaleInfo

java.lang.Object

org.geomajas.configuration.client.ScaleInfo

All Implemented Interfaces:

Serializable, IsInfo

@Api(allMethods=true)
public class ScaleInfo
extends Object
implements IsInfo

Represents a single scale. This class is needed to support 1:x notation because annotation-based formatters only support fields (no lists) and custom bean editors only support classes.

Since:

1.7.0

Author:

Jan De Moerloose

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static double	MAXIMUM_PIXEL_PER_UNIT A maximum pixelPerUnit value which is suitable for all purposes but avoids infinity and is in float range.
static double	MINIMUM_PIXEL_PER_UNIT A minimum pixelPerUnit value which is suitable for all purposes but avoids zero and is in float range.
static double	PIXEL_PER_METER Default conversion factor between map unit and pixel size (based on meter and 96 DPI).

Constructor Summary

Constructors

Constructor and Description
ScaleInfo() Default constructor for GWT serialization.
ScaleInfo(double pixelPerUnit) Constructs a scale info object with the specified scale value.
ScaleInfo(double numerator, double denominator) Constructs a scale info object with the specified numerator and denominator values.
ScaleInfo(ScaleInfo other) Copy constructor.

Method Summary

Methods

Modifier and Type	Method and Description
double	getConversionFactor() Get the conversion factor between map units and pixel size.
double	getDenominator() Returns the denominator for a relative scale.
double	getNumerator() Returns the numerator for a relative scale.
double	getPixelPerUnit() Returns the scale value in pixel per map unit.
boolean	isPixelPerUnitBased() Returns whether this scale is based on pixel per unit.
void	setConversionFactor(double conversionFactor) Deprecated. fixed to default (96 DPI) to avoid conflict with ClientApplicationInfo.getScreenDpi()
void	setDenominator(double denominator) Sets the denominator for a relative scale.
void	setNumerator(double numerator) Sets the numerator for a relative scale.
void	setPixelPerUnit(double pixelPerUnit) Sets the scale value in pixel per map unit.
void	setPixelPerUnitBased(boolean pixelPerUnitBased) Set this scale to be based on pixel per unit.

Methods inherited from class java.lang.Object

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

Field Detail

PIXEL_PER_METER

public static final double PIXEL_PER_METER

Default conversion factor between map unit and pixel size (based on meter and 96 DPI).

Since:

1.11.1

See Also:

Constant Field Values

MINIMUM_PIXEL_PER_UNIT

public static final double MINIMUM_PIXEL_PER_UNIT

A minimum pixelPerUnit value which is suitable for all purposes but avoids zero and is in float range.

See Also:

Constant Field Values

MAXIMUM_PIXEL_PER_UNIT

public static final double MAXIMUM_PIXEL_PER_UNIT

A maximum pixelPerUnit value which is suitable for all purposes but avoids infinity and is in float range.

See Also:

Constant Field Values

Constructor Detail

ScaleInfo

public ScaleInfo()

Default constructor for GWT serialization.

ScaleInfo

public ScaleInfo(double pixelPerUnit)

Constructs a scale info object with the specified scale value. The scale value should be interpreted as pixels/map unit. This is especially useful for raster images for which the image resolution indirectly determines the optimal view scale of the image.

Parameters:

pixelPerUnit - the scale value in pixel per map unit)

ScaleInfo

public ScaleInfo(double numerator,
         double denominator)

Constructs a scale info object with the specified numerator and denominator values. The scale should be interpreted as the more familiar pure number scale, i.e. 1 meter on the screen divided by 1 meter on the map.

Parameters:

numerator - typically value is 1 or > 1 for large scales

denominator - typically values are 100, 1000, ... or 1 for large scales

ScaleInfo

public ScaleInfo(ScaleInfo other)

Copy constructor. Creates a deep copy of the specified ScaleInfo object.

Parameters:

other - the scale info to copy

Since:

1.11.0

Method Detail

getPixelPerUnit

public double getPixelPerUnit()

Returns the scale value in pixel per map unit.

Returns:

the scale value (pix/map unit)

setPixelPerUnit

public void setPixelPerUnit(double pixelPerUnit)

Sets the scale value in pixel per map unit.

Parameters:

pixelPerUnit - the scale value (pix/map unit)

isPixelPerUnitBased

public boolean isPixelPerUnitBased()

Returns whether this scale is based on pixel per unit. If true, recalculations should use pixelPerUnit instead of nominator/denominator.

Returns:

true if in pixel per unit, false otherwise

Since:

1.11.1

setPixelPerUnitBased

public void setPixelPerUnitBased(boolean pixelPerUnitBased)

Set this scale to be based on pixel per unit. If true, recalculations should use pixelPerUnit instead of nominator/denominator.

Parameters:

pixelPerUnitBased - true if based on pixelPerUnit

Since:

1.11.1

getNumerator

public double getNumerator()

Returns the numerator for a relative scale.

Returns:

the scale numerator

setNumerator

public void setNumerator(double numerator)

Sets the numerator for a relative scale.

Parameters:

numerator - the numerator for a relative scale

getDenominator

public double getDenominator()

Returns the denominator for a relative scale.

Returns:

the scale denominator

setDenominator

public void setDenominator(double denominator)

Sets the denominator for a relative scale.

Parameters:

denominator - the denominator for a relative scale

getConversionFactor

public double getConversionFactor()

Get the conversion factor between map units and pixel size.

Returns:

the conversion factor

Since:

1.14.0

setConversionFactor

@Deprecated
public void setConversionFactor(double conversionFactor)

Deprecated. fixed to default (96 DPI) to avoid conflict with ClientApplicationInfo.getScreenDpi()

Set the conversion factor betweeen map units and pixel size. Defaults to PIXEL_PER_METER.

Parameters:

conversionFactor - the conversion factor

Since:

1.14.0