ilog.views.maps.graphic.style
Class IlvMapCompositeStyle

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

All Implemented Interfaces:

IlvPersistentObject, IlvInheritable, IlvMapStylePropertySheet.PropertyProvider

public class IlvMapCompositeStyle
extends IlvMapStyle
implements IlvMapStylePropertySheet.PropertyProvider

An IlvMapStyle that wraps a collection of IlvMapStyles.

Since:

JViews 7.5

Field Summary

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

IlvMapCompositeStyle()
Constructs an IlvMapCompositeStyle.

IlvMapCompositeStyle(IlvInputStream stream)
Reads a IlvMapCompositeStyle from an IlvInputStream

IlvMapCompositeStyle(IlvMapCompositeStyle source)
Constructor by copy

Method Summary

void	addChild(IlvMapStyle style) Deprecated. Since JViews 8.1 This method no longer sets the parent of the style and will become private. Use IlvMapStyle.setParent(IlvMapStyle) instead
IlvMapStyle	copy() Creates a copy of the style.
boolean	equals(Object o) Indicates whether some other object is "equal to" this one.
ilog.views.util.psheet.IlvPropertyDescriptor[]	getAdditionalDescriptors(Object target, ilog.views.util.psheet.IlvPropertyDescriptor[] descriptors) Returns the descriptors of the properties that must be added to the property sheet.
protected Object	getAttribute(String name, boolean useDefault) Retrieves the value for the attribute name.
IlvAttributeInfoProperty	getAttributeInfo() Retrieves the AttributeInfo property value.
int	hashCode()
boolean	isInherited(String name) Retrieves the inherited state of the property.
void	removeChild(IlvMapStyle style) Deprecated. Since JViews 8.1 This method no longer sets the parent of the style to null and will become private. Use IlvMapStyle.setParent(IlvMapStyle) with a null parameter instead
void	setAttribute(String name, Object o) Sets the value for the attribute whose name is name.
void	setInherited(String name, boolean i) Set the inherited state for this property.
void	write(IlvOutputStream stream) Writes a IlvMapCompositeStyle into an IlvOutputStream

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvMapCompositeStyle

public IlvMapCompositeStyle(IlvInputStream stream)
                     throws IlvReadFileException

Reads a IlvMapCompositeStyle from an IlvInputStream

Parameters:

stream - The stream to read from.

Throws:

IlvReadFileException

IlvMapCompositeStyle

public IlvMapCompositeStyle(IlvMapCompositeStyle source)

Constructor by copy

Parameters:

source - source style to copy

IlvMapCompositeStyle

public IlvMapCompositeStyle()

Constructs an IlvMapCompositeStyle.

Method Detail

write

public void write(IlvOutputStream stream)
           throws IOException

Writes a IlvMapCompositeStyle 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()

Creates a copy of the style.

Overrides:

copy in class IlvMapStyle

Returns:

a new IlvMapCompositeStyle

addChild

public void addChild(IlvMapStyle style)

Deprecated. Since JViews 8.1 This method no longer sets the parent of the style and will become private. Use IlvMapStyle.setParent(IlvMapStyle) instead

Add a IvMapStyle to this composite style.

Overrides:

addChild in class IlvMapStyle

Parameters:

style - The style to add.

removeChild

public void removeChild(IlvMapStyle style)

Deprecated. Since JViews 8.1 This method no longer sets the parent of the style to null and will become private. Use IlvMapStyle.setParent(IlvMapStyle) with a null parameter instead

Removes a child from this style.

Overrides:

removeChild in class IlvMapStyle

Parameters:

style - A child to be removed from this style.

See Also:

IlvMapStyle.removeChild(ilog.views.maps.graphic.style.IlvMapStyle)

getAttribute

protected Object getAttribute(String name,
                              boolean useDefault)

Retrieves the value for the attribute name. Instead of retrieving the attribute directly on this style, a search is made into the styles added to this style.

Overrides:

getAttribute in class IlvMapStyle

Parameters:

name - The name of the attribute to retrieve the value.

useDefault - if set to true and if the attribute has no value, return an eventual default value.

Returns:

The value for the attribute as set by setAttribute.

See Also:

.

isInherited

public boolean isInherited(String name)

Retrieves the inherited state of the property.

Specified by:

isInherited in interface IlvInheritable

Overrides:

isInherited in class IlvMapStyle

Parameters:

name - The name of the property to check.

Returns:

true if the property is marked as inherited, false otherwise.

setInherited

public void setInherited(String name,
                         boolean i)

Set the inherited state for this property. If a property is inherited, the value will be fetched on the parent if any.

Specified by:

setInherited in interface IlvInheritable

Overrides:

setInherited in class IlvMapStyle

Parameters:

name - The name of the property to mark

i - true if the property will be inherited, false otherwise.

getAttributeInfo

public IlvAttributeInfoProperty getAttributeInfo()

Retrieves the AttributeInfo property value.

Overrides:

getAttributeInfo in class IlvMapStyle

Returns:

The AttributeInfo property value or null if no value as been previously set.

See Also:

IlvMapStyle.getAttributeInfo()

setAttribute

public void setAttribute(String name,
                         Object o)

Sets the value for the attribute whose name is name. Instead of setting the attribute directly to this style, the value is set to a corresponding added style.

Overrides:

setAttribute in class IlvMapStyle

Parameters:

name - The name of the attribute.

o - The value for this attribute.

getAdditionalDescriptors

public ilog.views.util.psheet.IlvPropertyDescriptor[] getAdditionalDescriptors(Object target,
                                                                               ilog.views.util.psheet.IlvPropertyDescriptor[] descriptors)

Returns the descriptors of the properties that must be added to the property sheet.

Specified by:

getAdditionalDescriptors in interface IlvMapStylePropertySheet.PropertyProvider

Parameters:

target - The target object.

descriptors - The descriptors that have been obtained by the property sheet by introspecting the target object.

Returns:

The property descriptors to be added.

See Also:

IlvMapStylePropertySheet.PropertyProvider.getAdditionalDescriptors(java.lang.Object, ilog.views.util.psheet.IlvPropertyDescriptor[])

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)