com.esri.arcgis.carto
Class NestedLegendItem

java.lang.Object
  com.esri.arcgis.carto.NestedLegendItem

All Implemented Interfaces:

IHorizontalLegendItem, ILayerEffects, ILegendItem, ILegendItem2, ILegendItem3, INestedLegendItem, com.esri.arcgis.interop.RemoteObjRef, IClone, IPersist, IPersistStream, Externalizable, Serializable

public class NestedLegendItem
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, INestedLegendItem, IHorizontalLegendItem, ILegendItem, IClone, IPersistStream, IPersist, ILegendItem2, ILegendItem3, ILayerEffects, Externalizable

Nested legend item.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

NestedLegendItem()
Constructs a NestedLegendItem using ArcGIS Engine.

NestedLegendItem(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
NestedLegendItem theNestedLegendItem = (NestedLegendItem) obj;

Method Summary

void	assign(IClone src) Assigns the properties of src to the receiver.
void	changeFlowDirection(boolean rightToLeft) Indicates if a legend's flow direction changes.
void	createGraphics(IDisplay display, ILegendFormat legendFormat) Rebuilds the list of graphics.
boolean	equals(Object o) Compare this object with another
IClone	esri_clone() Clones the receiver and assigns the result to *clone.
int	getArrangement() Legend item arrangement.
short	getBrightness() Layer brightness in percent (-100 - 100).
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
short	getColumns() Number of columns in the legend item.
short	getContrast() Layer contrast in percent (-100 - 100).
IEnumElement	getGraphics() List of graphics that represent the legend item.
int	getGroupIndex() Zero-based index of the legend group shown by this item.
ITextSymbol	getHeadingSymbol() Text symbol used to draw the heading.
double	getHeight() Height of the item in points.
int	getHorizontalAlignment() Horizontal alignment of markers.
ILayer	getLayer() Associated layer.
ITextSymbol	getLayerNameSymbol() Text symbol used to draw the layer name.
double	getLeaderOverhang() Distance that the leaders extend past the circles (points).
ILineSymbol	getLeaderSymbol() Symbol used to draw the leader lines.
ILegendClassFormat	getLegendClassFormat() Default formatting information for the legend classes.
String	getName() Name of the style.
IFillSymbol	getOutlineSymbol() Symbol used to draw outlines.
double	getReferenceScaleRatio() The ratio calculated by dividing the map reference scale by the map scale.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
short	getTransparency() Layer transparency in percent (0-100).
double	getWidth() Width of the item in points.
int	hashCode() the hashcode for this object
boolean	isAutoLayout() Indicates if text automatically sizes to fit the markers.
boolean	isCanDisplay(ILayer layer) Indicates if the style is compatible with the specified layer.
void	isDirty() isDirty
boolean	isEqual(IClone other) Indicates if the receiver and other have the same properties.
boolean	isIdentical(IClone other) Indicates if the receiver and other are the same object.
boolean	isKeepTogether() Indicates if classes must appear in a single column or whether they can be split across multiple columns.
boolean	isLabelEnds() Indicates if only the first and last markers are labeled.
boolean	isNewColumn() Indicates if the item starts a new column in the legend.
boolean	isShowDescriptions() Indicates if descriptions are visible.
boolean	isShowHeading() Indicates if heading is visibile.
boolean	isShowLabels() Indicates if labels are visible.
boolean	isShowLayerName() Indicates if layer name is visibile.
boolean	isShowOutlines() Indicates if only the marker outlines are drawn.
boolean	isSupportsBrightnessChange() Indicates if the layer supports brightness changes.
boolean	isSupportsContrastChange() Indicates if the layer supports contrast changes.
boolean	isSupportsInteractive() Indicates if the layer supports interactive effects changes.
boolean	isSupportsTransparency() Indicates if the layer supports transparency.
void	load(IStream pstm) load
void	readExternal(ObjectInput in)
void	save(IStream pstm, int fClearDirty) save
void	setArrangement(int arrangement) Legend item arrangement.
void	setAutoLayout(boolean autoLayout) Indicates if text automatically sizes to fit the markers.
void	setBrightness(short brightnessValue) Layer brightness in percent (-100 - 100).
void	setColumns(short columns) Number of columns in the legend item.
void	setContrast(short contrastValue) Layer contrast in percent (-100 - 100).
void	setGroupIndex(int index) Zero-based index of the legend group shown by this item.
void	setHeadingSymbol(ITextSymbol symbol) Text symbol used to draw the heading.
void	setHorizontalAlignment(int horizAlignment) Horizontal alignment of markers.
void	setKeepTogether(boolean flag) Indicates if classes must appear in a single column or whether they can be split across multiple columns.
void	setLabelEnds(boolean labelEnds) Indicates if only the first and last markers are labeled.
void	setLayerByRef(ILayer layer) Associated layer.
void	setLayerNameSymbol(ITextSymbol symbol) Text symbol used to draw the layer name.
void	setLeaderOverhang(double leaderOverhang) Distance that the leaders extend past the circles (points).
void	setLeaderSymbol(ILineSymbol symbol) Symbol used to draw the leader lines.
void	setLegendClassFormat(ILegendClassFormat format) Default formatting information for the legend classes.
void	setNewColumn(boolean flag) Indicates if the item starts a new column in the legend.
void	setOutlineSymbol(IFillSymbol symbol) Symbol used to draw outlines.
void	setReferenceScaleRatio(double ratio) The ratio calculated by dividing the map reference scale by the map scale.
void	setShowDescriptions(boolean showDescriptions) Indicates if descriptions are visible.
void	setShowHeading(boolean showHeading) Indicates if heading is visibile.
void	setShowLabels(boolean showLabels) Indicates if labels are visible.
void	setShowLayerName(boolean showLayerName) Indicates if layer name is visibile.
void	setShowOutlines(boolean showOutlines) Indicates if only the marker outlines are drawn.
void	setSupportsInteractive(boolean supported) Indicates if the layer supports interactive effects changes.
void	setTransparency(short alpha) Layer transparency in percent (0-100).
void	writeExternal(ObjectOutput out)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

NestedLegendItem

public NestedLegendItem()
                 throws IOException,
                        UnknownHostException

Constructs a NestedLegendItem using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

NestedLegendItem

public NestedLegendItem(Object obj)
                 throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
NestedLegendItem theNestedLegendItem = (NestedLegendItem) obj;

Construct a NestedLegendItem using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to NestedLegendItem.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

setOutlineSymbol

public void setOutlineSymbol(IFillSymbol symbol)
                      throws IOException,
                             AutomationException

Symbol used to draw outlines.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setOutlineSymbol in interface INestedLegendItem

Parameters:

symbol - A reference to a com.esri.arcgis.display.IFillSymbol (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOutlineSymbol

public IFillSymbol getOutlineSymbol()
                             throws IOException,
                                    AutomationException

Symbol used to draw outlines.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getOutlineSymbol in interface INestedLegendItem

Returns:

A reference to a com.esri.arcgis.display.IFillSymbol

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLeaderSymbol

public void setLeaderSymbol(ILineSymbol symbol)
                     throws IOException,
                            AutomationException

Symbol used to draw the leader lines.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setLeaderSymbol in interface INestedLegendItem

Parameters:

symbol - A reference to a com.esri.arcgis.display.ILineSymbol (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLeaderSymbol

public ILineSymbol getLeaderSymbol()
                            throws IOException,
                                   AutomationException

Symbol used to draw the leader lines.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getLeaderSymbol in interface INestedLegendItem

Returns:

A reference to a com.esri.arcgis.display.ILineSymbol

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLeaderOverhang

public void setLeaderOverhang(double leaderOverhang)
                       throws IOException,
                              AutomationException

Distance that the leaders extend past the circles (points).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setLeaderOverhang in interface INestedLegendItem

Parameters:

leaderOverhang - The leaderOverhang (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLeaderOverhang

public double getLeaderOverhang()
                         throws IOException,
                                AutomationException

Distance that the leaders extend past the circles (points).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getLeaderOverhang in interface INestedLegendItem

Returns:

The leaderOverhang

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAutoLayout

public void setAutoLayout(boolean autoLayout)
                   throws IOException,
                          AutomationException

Indicates if text automatically sizes to fit the markers.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setAutoLayout in interface INestedLegendItem

Parameters:

autoLayout - The autoLayout (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAutoLayout

public boolean isAutoLayout()
                     throws IOException,
                            AutomationException

Indicates if text automatically sizes to fit the markers.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isAutoLayout in interface INestedLegendItem

Returns:

The autoLayout

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLabelEnds

public void setLabelEnds(boolean labelEnds)
                  throws IOException,
                         AutomationException

Indicates if only the first and last markers are labeled.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setLabelEnds in interface INestedLegendItem

Parameters:

labelEnds - The labelEnds (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isLabelEnds

public boolean isLabelEnds()
                    throws IOException,
                           AutomationException

Indicates if only the first and last markers are labeled.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isLabelEnds in interface INestedLegendItem

Returns:

The labelEnds

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setShowOutlines

public void setShowOutlines(boolean showOutlines)
                     throws IOException,
                            AutomationException

Indicates if only the marker outlines are drawn.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setShowOutlines in interface INestedLegendItem

Parameters:

showOutlines - The showOutlines (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isShowOutlines

public boolean isShowOutlines()
                       throws IOException,
                              AutomationException

Indicates if only the marker outlines are drawn.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isShowOutlines in interface INestedLegendItem

Returns:

The showOutlines

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHorizontalAlignment

public int getHorizontalAlignment()
                           throws IOException,
                                  AutomationException

Horizontal alignment of markers.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getHorizontalAlignment in interface INestedLegendItem

Returns:

A com.esri.arcgis.display.esriTextHorizontalAlignment constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHorizontalAlignment

public void setHorizontalAlignment(int horizAlignment)
                            throws IOException,
                                   AutomationException

Horizontal alignment of markers.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setHorizontalAlignment in interface INestedLegendItem

Parameters:

horizAlignment - A com.esri.arcgis.display.esriTextHorizontalAlignment constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getArrangement

public int getArrangement()
                   throws IOException,
                          AutomationException

Legend item arrangement.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getArrangement in interface IHorizontalLegendItem

Returns:

A com.esri.arcgis.carto.esriLegendItemArrangement constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setArrangement

public void setArrangement(int arrangement)
                    throws IOException,
                           AutomationException

Legend item arrangement.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setArrangement in interface IHorizontalLegendItem

Parameters:

arrangement - A com.esri.arcgis.carto.esriLegendItemArrangement constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getName

public String getName()
               throws IOException,
                      AutomationException

Name of the style.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getName in interface ILegendItem

Specified by:

getName in interface ILegendItem2

Specified by:

getName in interface ILegendItem3

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isCanDisplay

public boolean isCanDisplay(ILayer layer)
                     throws IOException,
                            AutomationException

Indicates if the style is compatible with the specified layer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

isCanDisplay in interface ILegendItem

Specified by:

isCanDisplay in interface ILegendItem2

Specified by:

isCanDisplay in interface ILegendItem3

Parameters:

layer - A reference to a com.esri.arcgis.carto.ILayer (in)

Returns:

The result

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLayer

public ILayer getLayer()
                throws IOException,
                       AutomationException

Associated layer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getLayer in interface ILegendItem

Specified by:

getLayer in interface ILegendItem2

Specified by:

getLayer in interface ILegendItem3

Returns:

A reference to a com.esri.arcgis.carto.ILayer

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLayerByRef

public void setLayerByRef(ILayer layer)
                   throws IOException,
                          AutomationException

Associated layer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setLayerByRef in interface ILegendItem

Specified by:

setLayerByRef in interface ILegendItem2

Specified by:

setLayerByRef in interface ILegendItem3

Parameters:

layer - A reference to a com.esri.arcgis.carto.ILayer (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isNewColumn

public boolean isNewColumn()
                    throws IOException,
                           AutomationException

Indicates if the item starts a new column in the legend.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isNewColumn in interface ILegendItem

Specified by:

isNewColumn in interface ILegendItem2

Specified by:

isNewColumn in interface ILegendItem3

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setNewColumn

public void setNewColumn(boolean flag)
                  throws IOException,
                         AutomationException

Indicates if the item starts a new column in the legend.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setNewColumn in interface ILegendItem

Specified by:

setNewColumn in interface ILegendItem2

Specified by:

setNewColumn in interface ILegendItem3

Parameters:

flag - The flag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getColumns

public short getColumns()
                 throws IOException,
                        AutomationException

Number of columns in the legend item.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getColumns in interface ILegendItem

Specified by:

getColumns in interface ILegendItem2

Specified by:

getColumns in interface ILegendItem3

Returns:

The columns

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setColumns

public void setColumns(short columns)
                throws IOException,
                       AutomationException

Number of columns in the legend item.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setColumns in interface ILegendItem

Specified by:

setColumns in interface ILegendItem2

Specified by:

setColumns in interface ILegendItem3

Parameters:

columns - The columns (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isKeepTogether

public boolean isKeepTogether()
                       throws IOException,
                              AutomationException

Indicates if classes must appear in a single column or whether they can be split across multiple columns.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isKeepTogether in interface ILegendItem

Specified by:

isKeepTogether in interface ILegendItem2

Specified by:

isKeepTogether in interface ILegendItem3

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setKeepTogether

public void setKeepTogether(boolean flag)
                     throws IOException,
                            AutomationException

Indicates if classes must appear in a single column or whether they can be split across multiple columns.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setKeepTogether in interface ILegendItem

Specified by:

setKeepTogether in interface ILegendItem2

Specified by:

setKeepTogether in interface ILegendItem3

Parameters:

flag - The flag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isShowLayerName

public boolean isShowLayerName()
                        throws IOException,
                               AutomationException

Indicates if layer name is visibile.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isShowLayerName in interface ILegendItem

Specified by:

isShowLayerName in interface ILegendItem2

Specified by:

isShowLayerName in interface ILegendItem3

Returns:

The showLayerName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setShowLayerName

public void setShowLayerName(boolean showLayerName)
                      throws IOException,
                             AutomationException

Indicates if layer name is visibile.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setShowLayerName in interface ILegendItem

Specified by:

setShowLayerName in interface ILegendItem2

Specified by:

setShowLayerName in interface ILegendItem3

Parameters:

showLayerName - The showLayerName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLayerNameSymbol

public ITextSymbol getLayerNameSymbol()
                               throws IOException,
                                      AutomationException

Text symbol used to draw the layer name.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getLayerNameSymbol in interface ILegendItem

Specified by:

getLayerNameSymbol in interface ILegendItem2

Specified by:

getLayerNameSymbol in interface ILegendItem3

Returns:

A reference to a com.esri.arcgis.display.ITextSymbol

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLayerNameSymbol

public void setLayerNameSymbol(ITextSymbol symbol)
                        throws IOException,
                               AutomationException

Text symbol used to draw the layer name.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setLayerNameSymbol in interface ILegendItem

Specified by:

setLayerNameSymbol in interface ILegendItem2

Specified by:

setLayerNameSymbol in interface ILegendItem3

Parameters:

symbol - A reference to a com.esri.arcgis.display.ITextSymbol (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGroupIndex

public int getGroupIndex()
                  throws IOException,
                         AutomationException

Zero-based index of the legend group shown by this item. Use -1 to show all legend groups using this item.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getGroupIndex in interface ILegendItem

Specified by:

getGroupIndex in interface ILegendItem2

Specified by:

getGroupIndex in interface ILegendItem3

Returns:

The index

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setGroupIndex

public void setGroupIndex(int index)
                   throws IOException,
                          AutomationException

Zero-based index of the legend group shown by this item. Use -1 to show all legend groups using this item.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setGroupIndex in interface ILegendItem

Specified by:

setGroupIndex in interface ILegendItem2

Specified by:

setGroupIndex in interface ILegendItem3

Parameters:

index - The index (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isShowHeading

public boolean isShowHeading()
                      throws IOException,
                             AutomationException

Indicates if heading is visibile.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isShowHeading in interface ILegendItem

Specified by:

isShowHeading in interface ILegendItem2

Specified by:

isShowHeading in interface ILegendItem3

Returns:

The showHeading

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setShowHeading

public void setShowHeading(boolean showHeading)
                    throws IOException,
                           AutomationException

Indicates if heading is visibile.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setShowHeading in interface ILegendItem

Specified by:

setShowHeading in interface ILegendItem2

Specified by:

setShowHeading in interface ILegendItem3

Parameters:

showHeading - The showHeading (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHeadingSymbol

public ITextSymbol getHeadingSymbol()
                             throws IOException,
                                    AutomationException

Text symbol used to draw the heading.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getHeadingSymbol in interface ILegendItem

Specified by:

getHeadingSymbol in interface ILegendItem2

Specified by:

getHeadingSymbol in interface ILegendItem3

Returns:

A reference to a com.esri.arcgis.display.ITextSymbol

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHeadingSymbol

public void setHeadingSymbol(ITextSymbol symbol)
                      throws IOException,
                             AutomationException

Text symbol used to draw the heading.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setHeadingSymbol in interface ILegendItem

Specified by:

setHeadingSymbol in interface ILegendItem2

Specified by:

setHeadingSymbol in interface ILegendItem3

Parameters:

symbol - A reference to a com.esri.arcgis.display.ITextSymbol (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLegendClassFormat

public ILegendClassFormat getLegendClassFormat()
                                        throws IOException,
                                               AutomationException

Default formatting information for the legend classes. Renderer may override.

Description

The layer can provide legend class formatting information via ILegendClass.Format. This makes it possible to store legend formatting information with layers in metadata-like fashion. However, layers normally do not provide a LegendClassFormat object. Rather, legend formatting information usually comes from the legend. ILegendItem.LegendClassFormat is used and some patch settings can come from ILegend.LegendFormat .

So, when a legend is created, the code follows this logic:

1. Check if ILegendClass.Format exists for the layer. If not, use ILegendItem.LegendClassFormat.
2. For the patch settings, if a setting in ILegendItem.LegendClassFormat is null, then use the default value in ILegend.LegendFormat.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getLegendClassFormat in interface ILegendItem

Specified by:

getLegendClassFormat in interface ILegendItem2

Specified by:

getLegendClassFormat in interface ILegendItem3

Returns:

A reference to a com.esri.arcgis.carto.ILegendClassFormat

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLegendClassFormat

public void setLegendClassFormat(ILegendClassFormat format)
                          throws IOException,
                                 AutomationException

Default formatting information for the legend classes. Renderer may override.

Description

The layer can provide legend class formatting information via ILegendClass.Format. This makes it possible to store legend formatting information with layers in metadata-like fashion. However, layers normally do not provide a LegendClassFormat object. Rather, legend formatting information usually comes from the legend. ILegendItem.LegendClassFormat is used and some patch settings can come from ILegend.LegendFormat .

So, when a legend is created, the code follows this logic:

1. Check if ILegendClass.Format exists for the layer. If not, use ILegendItem.LegendClassFormat.
2. For the patch settings, if a setting in ILegendItem.LegendClassFormat is null, then use the default value in ILegend.LegendFormat.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setLegendClassFormat in interface ILegendItem

Specified by:

setLegendClassFormat in interface ILegendItem2

Specified by:

setLegendClassFormat in interface ILegendItem3

Parameters:

format - A reference to a com.esri.arcgis.carto.ILegendClassFormat (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isShowLabels

public boolean isShowLabels()
                     throws IOException,
                            AutomationException

Indicates if labels are visible.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isShowLabels in interface ILegendItem

Specified by:

isShowLabels in interface ILegendItem2

Specified by:

isShowLabels in interface ILegendItem3

Returns:

The showLabels

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setShowLabels

public void setShowLabels(boolean showLabels)
                   throws IOException,
                          AutomationException

Indicates if labels are visible.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setShowLabels in interface ILegendItem

Specified by:

setShowLabels in interface ILegendItem2

Specified by:

setShowLabels in interface ILegendItem3

Parameters:

showLabels - The showLabels (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isShowDescriptions

public boolean isShowDescriptions()
                           throws IOException,
                                  AutomationException

Indicates if descriptions are visible.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isShowDescriptions in interface ILegendItem

Specified by:

isShowDescriptions in interface ILegendItem2

Specified by:

isShowDescriptions in interface ILegendItem3

Returns:

The showDescriptions

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setShowDescriptions

public void setShowDescriptions(boolean showDescriptions)
                         throws IOException,
                                AutomationException

Indicates if descriptions are visible.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setShowDescriptions in interface ILegendItem

Specified by:

setShowDescriptions in interface ILegendItem2

Specified by:

setShowDescriptions in interface ILegendItem3

Parameters:

showDescriptions - The showDescriptions (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createGraphics

public void createGraphics(IDisplay display,
                           ILegendFormat legendFormat)
                    throws IOException,
                           AutomationException

Rebuilds the list of graphics. Call whenever the associated layer changes.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

createGraphics in interface ILegendItem

Specified by:

createGraphics in interface ILegendItem2

Specified by:

createGraphics in interface ILegendItem3

Parameters:

display - A reference to a com.esri.arcgis.display.IDisplay (in)

legendFormat - A reference to a com.esri.arcgis.carto.ILegendFormat (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWidth

public double getWidth()
                throws IOException,
                       AutomationException

Width of the item in points. Must call CreateGraphics first.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getWidth in interface ILegendItem

Specified by:

getWidth in interface ILegendItem2

Specified by:

getWidth in interface ILegendItem3

Returns:

The width

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHeight

public double getHeight()
                 throws IOException,
                        AutomationException

Height of the item in points. Must call CreateGraphics first.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getHeight in interface ILegendItem

Specified by:

getHeight in interface ILegendItem2

Specified by:

getHeight in interface ILegendItem3

Returns:

The height

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGraphics

public IEnumElement getGraphics()
                         throws IOException,
                                AutomationException

List of graphics that represent the legend item. Must call CreateGraphics first.

Description

Graphics are measured in points. The lower left corner is (0, 0). Put elements in groups to keep the legend from flowing them across columns.

Remarks

Each element in the graphic list should be flowable, i.e,. can be moved to a new column in the legend if necessary. Implement "keep together" by putting the elements that need to stay together in a group. The top level elements must be put in the list in top to bottom order.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getGraphics in interface ILegendItem

Specified by:

getGraphics in interface ILegendItem2

Specified by:

getGraphics in interface ILegendItem3

Returns:

A reference to a com.esri.arcgis.carto.IEnumElement

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

esri_clone

public IClone esri_clone()
                  throws IOException,
                         AutomationException

Clones the receiver and assigns the result to *clone.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

esri_clone in interface IClone

Returns:

A reference to a com.esri.arcgis.system.IClone

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws IOException,
                   AutomationException

Assigns the properties of src to the receiver.

Description

Use Assign method to assign the properties of source object to receiver object. Both objects need to have the same CLSIDs. Both source and receiver objects need to be instantiated.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

assign in interface IClone

Parameters:

src - A reference to a com.esri.arcgis.system.IClone (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws IOException,
                       AutomationException

Indicates if the receiver and other have the same properties.

Description

IsEqual returns True if the receiver and the source have the same properties. Note, this does not imply that the receiver and the source reference the same object.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isEqual in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The equal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws IOException,
                           AutomationException

Indicates if the receiver and other are the same object.

Description

IsIdentical returns true if the receiver and the source reference the same object.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isIdentical in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The identical

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException

isDirty

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isDirty in interface IPersistStream

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException

load

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws IOException,
                 AutomationException

save

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws IOException,
                       AutomationException

getSizeMax

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws IOException,
                       AutomationException

getClassID

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

changeFlowDirection

public void changeFlowDirection(boolean rightToLeft)
                         throws IOException,
                                AutomationException

Indicates if a legend's flow direction changes. Update alignment settings.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

changeFlowDirection in interface ILegendItem2

Specified by:

changeFlowDirection in interface ILegendItem3

Parameters:

rightToLeft - The rightToLeft (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getReferenceScaleRatio

public double getReferenceScaleRatio()
                              throws IOException,
                                     AutomationException

The ratio calculated by dividing the map reference scale by the map scale. Allows legend symbols to honor the map's reference scale.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getReferenceScaleRatio in interface ILegendItem3

Returns:

The ratio

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReferenceScaleRatio

public void setReferenceScaleRatio(double ratio)
                            throws IOException,
                                   AutomationException

The ratio calculated by dividing the map reference scale by the map scale. Allows legend symbols to honor the map's reference scale.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setReferenceScaleRatio in interface ILegendItem3

Parameters:

ratio - The ratio (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSupportsTransparency

public boolean isSupportsTransparency()
                               throws IOException,
                                      AutomationException

Indicates if the layer supports transparency.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isSupportsTransparency in interface ILayerEffects

Returns:

The supported

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSupportsContrastChange

public boolean isSupportsContrastChange()
                                 throws IOException,
                                        AutomationException

Indicates if the layer supports contrast changes.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isSupportsContrastChange in interface ILayerEffects

Returns:

The supported

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSupportsBrightnessChange

public boolean isSupportsBrightnessChange()
                                   throws IOException,
                                          AutomationException

Indicates if the layer supports brightness changes.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isSupportsBrightnessChange in interface ILayerEffects

Returns:

The supported

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSupportsInteractive

public void setSupportsInteractive(boolean supported)
                            throws IOException,
                                   AutomationException

Indicates if the layer supports interactive effects changes.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setSupportsInteractive in interface ILayerEffects

Parameters:

supported - The supported (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSupportsInteractive

public boolean isSupportsInteractive()
                              throws IOException,
                                     AutomationException

Indicates if the layer supports interactive effects changes.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isSupportsInteractive in interface ILayerEffects

Returns:

The supported

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTransparency

public short getTransparency()
                      throws IOException,
                             AutomationException

Layer transparency in percent (0-100).

Remarks

When you set Transparency for a FeatureLayer, a TransparencyDisplayFilter is created and applied to the layer. You can accomplish the same effect by manually creating a new TransparencyDisplayFilter using IDisplayFilter, and then assigning it to a layer using IDisplayFilterManager.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getTransparency in interface ILayerEffects

Returns:

The alpha

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTransparency

public void setTransparency(short alpha)
                     throws IOException,
                            AutomationException

Layer transparency in percent (0-100).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setTransparency in interface ILayerEffects

Parameters:

alpha - The alpha (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getContrast

public short getContrast()
                  throws IOException,
                         AutomationException

Layer contrast in percent (-100 - 100).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getContrast in interface ILayerEffects

Returns:

The contrastValue

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setContrast

public void setContrast(short contrastValue)
                 throws IOException,
                        AutomationException

Layer contrast in percent (-100 - 100).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setContrast in interface ILayerEffects

Parameters:

contrastValue - The contrastValue (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBrightness

public short getBrightness()
                    throws IOException,
                           AutomationException

Layer brightness in percent (-100 - 100).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getBrightness in interface ILayerEffects

Returns:

The brightnessValue

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBrightness

public void setBrightness(short brightnessValue)
                   throws IOException,
                          AutomationException

Layer brightness in percent (-100 - 100).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setBrightness in interface ILayerEffects

Parameters:

brightnessValue - The brightnessValue (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException