ilog.views.maps.grids

Class IlvGridStyle

java.lang.Object

ilog.views.maps.graphic.style.IlvMapStyle

ilog.views.maps.grids.IlvGridStyle

All Implemented Interfaces:

IlvPersistentObject, IlvInheritable, Serializable

public class IlvGridStyle
extends IlvMapStyle

A IlvMapStyle intended to be used with a grid.

Since:

JViews 7.5

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	BASE_TEXT_DIRECTION The baseTextDirection property name.
static String	GRID_COLOR The gridColor property name.
static String	TEXT_COLOR The textColor property name.
static String	TEXT_FONT The textFont property name.
static String	TEXT_OUTLINE_COLOR The textOutlineColor property name.

Fields inherited from class ilog.views.maps.graphic.style.IlvMapStyle

ALPHA, ALWAYS_ON_TOP, ATTRIBUTE_INFO, CATEGORY, LABEL_ATTRIBUTE, LEGEND_GROUP, PARENT, THIN_CLIENT_BACKGROUND, VISIBLE_IN_3DVIEW, VISIBLE_IN_OVERVIEW, VISIBLE_IN_TREE, VISIBLE_IN_VIEW

Constructor Summary

Constructors

Constructor and Description
IlvGridStyle() Constructs an IlvPointStyle
IlvGridStyle(IlvGridStyle source) Constructs a IlvPointStyle by copying an existing one.
IlvGridStyle(IlvInputStream stream) Reads a IlvGridStyle from a IlvInputStream

Method Summary

Modifier and Type	Method and Description
IlvMapStyle	copy() Return a copy of the style.
boolean	equals(Object o) Indicates whether some other object is "equal to" this one.
int	getBaseTextDirection() Returns the base direction of the grid labels.
Color	getGridColor() Retrieve the GRID_COLOR attribute value.
Color	getTextColor() Retrieve the TEXT_COLOR attribute value.
Font	getTextFont() Retrieve the TEXT_FONT attribute value.
Color	getTextOutlineColor() Retrieve the TEXT_OUTLINE_COLOR attribute value.
void	setBaseTextDirection(int textDir) Changes the base direction of the grid labels.
void	setGridColor(Color c) Sets the GRID_COLOR attribute value.
void	setTextColor(Color c) Sets the TEXT_COLOR attribute value.
void	setTextFont(Font c) Sets the TEXT_FONT attribute value.
void	setTextOutlineColor(Color c) Sets the TEXT_OUTLINE_COLOR attribute value.
void	write(IlvOutputStream stream) write an IlvPointStyle into an IlvOutputStream

Methods inherited from class ilog.views.maps.graphic.style.IlvMapStyle

addAttributeListener, addChild, addStyleListener, addWeakStyleListener, getAlpha, getAttribute, getAttribute, getAttributeFilter, getAttributeInfo, getAttributeListeners, getCategory, getChildren, getDefaultValues, getGraphic, getLabelAttribute, getLegendGroup, getListeners, getParent, getStyleListeners, hashCode, isAlwaysOnTop, isInherited, isThinClientBackground, isVisibleIn3DView, isVisibleInOverview, isVisibleInTree, isVisibleInView, objectEquals, removeAttributeListener, removeChild, removeStyleListener, setAlpha, setAlwaysOnTop, setAttribute, setAttributeFilter, setAttributeInfo, setCategory, setGraphic, setInherited, setLabelAttribute, setLegendGroup, setParent, setThinClientBackground, setVisibleIn3DView, setVisibleInOverview, setVisibleInTree, setVisibleInView

Methods inherited from class java.lang.Object

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

Field Detail

GRID_COLOR

public static final String GRID_COLOR

The gridColor property name.

See Also:

Constant Field Values

TEXT_COLOR

public static final String TEXT_COLOR

The textColor property name.

See Also:

Constant Field Values

TEXT_OUTLINE_COLOR

public static final String TEXT_OUTLINE_COLOR

The textOutlineColor property name.

Since:

JViews 7.5

See Also:

Constant Field Values

TEXT_FONT

public static final String TEXT_FONT

The textFont property name.

See Also:

Constant Field Values

BASE_TEXT_DIRECTION

public static final String BASE_TEXT_DIRECTION

The baseTextDirection property name.

Since:

JViews 8.8

See Also:

Constant Field Values

Constructor Detail

IlvGridStyle

public IlvGridStyle(IlvInputStream stream)
             throws IlvReadFileException

Reads a IlvGridStyle from a IlvInputStream

Parameters:

stream - The stream to read from.

Throws:

IlvReadFileException

IlvGridStyle

public IlvGridStyle()

Constructs an IlvPointStyle

IlvGridStyle

public IlvGridStyle(IlvGridStyle source)

Constructs a IlvPointStyle by copying an existing one.

Parameters:

source - The style to copy.

Method Detail

write

public void write(IlvOutputStream stream)
           throws IOException

write an IlvPointStyle into an IlvOutputStream

Specified by:

write in interface IlvPersistentObject

Overrides:

write in class IlvMapStyle

Parameters:

stream - The stream to write to.

Throws:

IOException

copy

public IlvMapStyle copy()

Return a copy of the style.

Overrides:

copy in class IlvMapStyle

Returns:

A copy of the style.

See Also:

IlvMapStyle.copy()

equals

public boolean equals(Object o)

Indicates whether some other object is "equal to" this one.

Overrides:

equals in class IlvMapStyle

See Also:

IlvMapStyle.equals(java.lang.Object)

getGridColor

public Color getGridColor()

Retrieve the GRID_COLOR attribute value.

Returns:

The GRID_COLOR attribute value.

setGridColor

public void setGridColor(Color c)

Sets the GRID_COLOR attribute value.

Parameters:

c - The GRID_COLOR attribute value as a Color

getTextColor

public Color getTextColor()

Retrieve the TEXT_COLOR attribute value.

Returns:

The TEXT_COLOR attribute value.

setTextOutlineColor

public void setTextOutlineColor(Color c)

Sets the TEXT_OUTLINE_COLOR attribute value.

Parameters:

c - The TEXT_OUTLINE_COLOR attribute value as a Color

Since:

JViews 7.5

getTextOutlineColor

public Color getTextOutlineColor()

Retrieve the TEXT_OUTLINE_COLOR attribute value.

Returns:

The TEXT_OUTLINE_COLOR attribute value.

Since:

JViews 7.5

setTextColor

public void setTextColor(Color c)

Sets the TEXT_COLOR attribute value.

Parameters:

c - The TEXT_COLOR attribute value as a Color

getTextFont

public Font getTextFont()

Retrieve the TEXT_FONT attribute value.

Returns:

The TEXT_FONT attribute value.

setTextFont

public void setTextFont(Font c)

Sets the TEXT_FONT attribute value.

Parameters:

c - The TEXT_FONT attribute value as a Font

setBaseTextDirection

public void setBaseTextDirection(int textDir)

Changes the base direction of the grid labels.

Parameters:

textDir - One of the following values:

• IlvBidiUtil.INHERITED_DIRECTION: base text direction is inherited
• IlvBidiUtil.COMPONENT_DIRECTION: default GUI base text direction
• IlvBidiUtil.LEFT_TO_RIGHT: left-to-right base text direction.
• IlvBidiUtil.RIGHT_TO_LEFT: right-to-left base text direction.
• IlvBidiUtil.CONTEXTUAL_DIRECTION: contextual base text direction.

Since:

JViews 8.8

getBaseTextDirection

public int getBaseTextDirection()

Returns the base direction of the grid labels.

Returns:

One of the following values:

• IlvBidiUtil.INHERITED_DIRECTION: base text direction is inherited
• IlvBidiUtil.COMPONENT_DIRECTION: default GUI base text direction
• IlvBidiUtil.LEFT_TO_RIGHT: left-to-right base text direction.
• IlvBidiUtil.RIGHT_TO_LEFT: right-to-left base text direction.
• IlvBidiUtil.CONTEXTUAL_DIRECTION: contextual base text direction.

Since:

JViews 8.8