ilog.views.maps.graphic.style
Class IlvPointStyle

java.lang.Object
  ilog.views.maps.graphic.style.IlvMapStyle
      ilog.views.maps.graphic.style.IlvPointStyle

All Implemented Interfaces:

IlvPersistentObject, IlvInheritable

public class IlvPointStyle
extends IlvMapStyle

A IlvMapStyle intended to be used with a IlvMapMarker.

Since:

JViews 7.5

Field Summary

static String	FOREGROUND The Foreground property name.
static String	MARKER_CHAR The MarkerChar property name.
static String	MARKER_FONT The MarkerFont property name.
static String	MARKER_IMAGE The MarkerImage property name.
static String	MARKER_IMAGE_SOURCE The MarkerImageSource property name.
static String	MARKER_SIZE The MarkerSize property name.
static String	MARKER_TYPE The MarkerType 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

IlvPointStyle()
Constructs an IlvPointStyle

IlvPointStyle(IlvInputStream stream)
Reads a IlvPointStyle from a IlvInputStream

IlvPointStyle(IlvPointStyle source)
Constructs a IlvPointStyle by copying an existing one.

Method Summary

IlvMapStyle	copy() Return a copy of the style.
boolean	equals(Object o) Indicates whether some other object is "equal to" this one.
char	getChar() Retrieves the Type attribute value.
Font	getFont() Retrieves the Font attribute value.
Color	getForeground() Retrieve the FOREGROUND attribute value.
Image	getImage() Retrieves either an image from the ImageSource property or the image set by calling setImage(Image).
String	getImageSource() Retrieves the ImageSource attribute value.
int	getSize() Retrieves the Size attribute value.
int	getType() Retrieves the Type attribute value.
int	hashCode()
void	setChar(char tchar) Sets the Char attribute value.
void	setFont(Font font) Sets the Font attribute value.
void	setForeground(Color c) Sets the FOREGROUND attribute value.
void	setImage(Image img) Sets an Image object so that calls to getImage will return it.
void	setImageSource(String source) Sets the ImageSource attribute value.
void	setSize(int size) Sets the Size attribute value.
void	setType(int type) Sets the Type 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, 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

FOREGROUND

public static final String FOREGROUND

The Foreground property name.

See Also:

Constant Field Values

MARKER_SIZE

public static final String MARKER_SIZE

The MarkerSize property name.

See Also:

Constant Field Values

MARKER_TYPE

public static final String MARKER_TYPE

The MarkerType property name.

See Also:

Constant Field Values

MARKER_CHAR

public static final String MARKER_CHAR

The MarkerChar property name.

Since:

JViews 7.5

See Also:

Constant Field Values

MARKER_FONT

public static final String MARKER_FONT

The MarkerFont property name.

Since:

JViews 7.5

See Also:

Constant Field Values

MARKER_IMAGE

public static final String MARKER_IMAGE

The MarkerImage property name.

Since:

JViews 8.0

See Also:

Constant Field Values

MARKER_IMAGE_SOURCE

public static final String MARKER_IMAGE_SOURCE

The MarkerImageSource property name.

Since:

JViews 8.0

See Also:

Constant Field Values

Constructor Detail

IlvPointStyle

public IlvPointStyle(IlvInputStream stream)
              throws IlvReadFileException

Reads a IlvPointStyle from a IlvInputStream

Parameters:

stream - The stream to read from.

Throws:

IlvReadFileException

IlvPointStyle

public IlvPointStyle()

Constructs an IlvPointStyle

IlvPointStyle

public IlvPointStyle(IlvPointStyle 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()

hashCode

public int hashCode()

Overrides:

hashCode in class IlvMapStyle

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)

getForeground

public Color getForeground()

Retrieve the FOREGROUND attribute value.

Returns:

The FOREGROUND attribute value.

setForeground

public void setForeground(Color c)

Sets the FOREGROUND attribute value.

Parameters:

c - The FOREGROUND attribute value as a Color

getSize

public int getSize()

Retrieves the Size attribute value.

Returns:

The Size attribute value.

setSize

public void setSize(int size)

Sets the Size attribute value.

Parameters:

size -

getType

public int getType()

Retrieves the Type attribute value.

Returns:

The Type attribute value.

setType

public void setType(int type)

Sets the Type attribute value.

Parameters:

type - The Type attribute value.

getFont

public Font getFont()

Retrieves the Font attribute value.

Returns:

The Font attribute value.

Since:

JViews 7.5

setFont

public void setFont(Font font)

Sets the Font attribute value.

Parameters:

font - The Type attribute value.

Since:

JViews 7.5

getChar

public char getChar()

Retrieves the Type attribute value.

Returns:

The Type attribute value.

Since:

JViews 7.5

setChar

public void setChar(char tchar)

Sets the Char attribute value.

Parameters:

tchar - The Char attribute value.

Since:

JViews 7.5

getImageSource

public String getImageSource()

Retrieves the ImageSource attribute value.

Returns:

The ImageSource attribute value.

Since:

JViews 8.0

setImageSource

public void setImageSource(String source)

Sets the ImageSource attribute value.

Parameters:

source - The ImageSource attribute value.

Since:

JViews 8.0

getImage

public Image getImage()

Retrieves either an image from the ImageSource property or the image set by calling setImage(Image). If the ImageSource property has been set to a valid image location, the corresponding image is returned.

Returns:

The image pointed to by the ImageSource property or null.

Since:

JViews 8.0

See Also:

setImageSource(String), getImageSource(), setImage(Image)

setImage

public void setImage(Image img)

Sets an Image object so that calls to getImage will return it. Setting img to null will force the getImage method to retrieve the image from the ImageSource property.

Parameters:

img - The image to set.

Since:

JViews 8.0