com.esri.arcgis.carto
Class HorizontalLegendItem

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

All Implemented Interfaces:

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

public class HorizontalLegendItem
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IHorizontalLegendItem, ILegendItem, IClone, IPersistStream, IPersist, ILegendItem2, ILegendItem3, ILayerEffects, java.io.Externalizable

COM Class 'HorizontalLegendItem'. Generated 3/19/2015 1:20:41 PM from 'C:\ArcGIS\COM\esriCarto.olb'

Description 'Horizontal legend item.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:

Serialized Form

Field Summary

static long

serialVersionUID

Fields inherited from interface com.esri.arcgis.carto.IHorizontalLegendItem

IID, IID8a7a1786_79b2_11d2_87d5_0000f8751720, xxDummy

Fields inherited from interface com.esri.arcgis.carto.ILegendItem

IID, IID52aa5bc0_cb21_11d0_87f9_080009ec732a, xxDummy

Fields inherited from interface com.esri.arcgis.system.IClone

IID, IID9bff8aeb_e415_11d0_943c_080009eebecb, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersistStream

IID, IID00000109_0000_0000_c000_000000000046, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersist

IID0000010c_0000_0000_c000_000000000046

Fields inherited from interface com.esri.arcgis.carto.ILegendItem2

IID, IID7d23f970_d5a6_4c1c_8618_3cc7b5839efa, xxDummy

Fields inherited from interface com.esri.arcgis.carto.ILegendItem3

IID, IID1dc64b35_9613_4007_bec5_3ad4f1b9dfb7, xxDummy

Fields inherited from interface com.esri.arcgis.carto.ILayerEffects

IID, IID09998199_1fb8_11d3_ab4e_000000000000, xxDummy

Constructor Summary

HorizontalLegendItem()
Constructs a HorizontalLegendItem using ArcGIS Engine.

HorizontalLegendItem(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
HorizontalLegendItem theHorizontalLegendItem = (HorizontalLegendItem) 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(java.lang.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 java.lang.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.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
ILayer	getLayer() Associated layer.
ITextSymbol	getLayerNameSymbol() Text symbol used to draw the layer name.
ILegendClassFormat	getLegendClassFormat() Default formatting information for the legend classes.
java.lang.String	getName() Name of the style.
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	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	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	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(java.io.ObjectInput in)
void	release() Release a HorizontalLegendItem.
void	save(IStream pstm, int fClearDirty) save
void	setArrangement(int arrangement) Legend item arrangement.
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	setKeepTogether(boolean flag) Indicates if classes must appear in a single column or whether they can be split across multiple columns.
void	setLayerByRef(ILayer layer) Associated layer.
void	setLayerNameSymbol(ITextSymbol symbol) Text symbol used to draw the layer name.
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	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	setSupportsInteractive(boolean supported) Indicates if the layer supports interactive effects changes.
void	setTransparency(short alpha) Layer transparency in percent (0-100).
void	writeExternal(java.io.ObjectOutput out)

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

HorizontalLegendItem

public HorizontalLegendItem()
                     throws java.io.IOException,
                            java.net.UnknownHostException

Constructs a HorizontalLegendItem using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

HorizontalLegendItem

public HorizontalLegendItem(java.lang.Object obj)
                     throws java.io.IOException

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

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Deprecated. Internal use only.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()

Release a HorizontalLegendItem.

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

getArrangement

public int getArrangement()
                   throws java.io.IOException,
                          AutomationException

Legend item arrangement.

Specified by:

getArrangement in interface IHorizontalLegendItem

Returns:

A com.esri.arcgis.carto.esriLegendItemArrangement constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setArrangement

public void setArrangement(int arrangement)
                    throws java.io.IOException,
                           AutomationException

Legend item arrangement.

Specified by:

setArrangement in interface IHorizontalLegendItem

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getName

public java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException

Name of the style.

Specified by:

getName in interface ILegendItem

Specified by:

getName in interface ILegendItem2

Specified by:

getName in interface ILegendItem3

Returns:

The name

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isCanDisplay

public boolean isCanDisplay(ILayer layer)
                     throws java.io.IOException,
                            AutomationException

Indicates if the style is compatible with the specified layer.

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLayer

public ILayer getLayer()
                throws java.io.IOException,
                       AutomationException

Associated layer.

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLayerByRef

public void setLayerByRef(ILayer layer)
                   throws java.io.IOException,
                          AutomationException

Associated layer.

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isNewColumn

public boolean isNewColumn()
                    throws java.io.IOException,
                           AutomationException

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

Specified by:

isNewColumn in interface ILegendItem

Specified by:

isNewColumn in interface ILegendItem2

Specified by:

isNewColumn in interface ILegendItem3

Returns:

The flag

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setNewColumn

public void setNewColumn(boolean flag)
                  throws java.io.IOException,
                         AutomationException

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

Specified by:

setNewColumn in interface ILegendItem

Specified by:

setNewColumn in interface ILegendItem2

Specified by:

setNewColumn in interface ILegendItem3

Parameters:

flag - The flag (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getColumns

public short getColumns()
                 throws java.io.IOException,
                        AutomationException

Number of columns in the legend item.

Specified by:

getColumns in interface ILegendItem

Specified by:

getColumns in interface ILegendItem2

Specified by:

getColumns in interface ILegendItem3

Returns:

The columns

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setColumns

public void setColumns(short columns)
                throws java.io.IOException,
                       AutomationException

Number of columns in the legend item.

Specified by:

setColumns in interface ILegendItem

Specified by:

setColumns in interface ILegendItem2

Specified by:

setColumns in interface ILegendItem3

Parameters:

columns - The columns (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isKeepTogether

public boolean isKeepTogether()
                       throws java.io.IOException,
                              AutomationException

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

Specified by:

isKeepTogether in interface ILegendItem

Specified by:

isKeepTogether in interface ILegendItem2

Specified by:

isKeepTogether in interface ILegendItem3

Returns:

The flag

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setKeepTogether

public void setKeepTogether(boolean flag)
                     throws java.io.IOException,
                            AutomationException

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

Specified by:

setKeepTogether in interface ILegendItem

Specified by:

setKeepTogether in interface ILegendItem2

Specified by:

setKeepTogether in interface ILegendItem3

Parameters:

flag - The flag (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isShowLayerName

public boolean isShowLayerName()
                        throws java.io.IOException,
                               AutomationException

Indicates if layer name is visibile.

Specified by:

isShowLayerName in interface ILegendItem

Specified by:

isShowLayerName in interface ILegendItem2

Specified by:

isShowLayerName in interface ILegendItem3

Returns:

The showLayerName

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setShowLayerName

public void setShowLayerName(boolean showLayerName)
                      throws java.io.IOException,
                             AutomationException

Indicates if layer name is visibile.

Specified by:

setShowLayerName in interface ILegendItem

Specified by:

setShowLayerName in interface ILegendItem2

Specified by:

setShowLayerName in interface ILegendItem3

Parameters:

showLayerName - The showLayerName (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLayerNameSymbol

public ITextSymbol getLayerNameSymbol()
                               throws java.io.IOException,
                                      AutomationException

Text symbol used to draw the layer name.

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLayerNameSymbol

public void setLayerNameSymbol(ITextSymbol symbol)
                        throws java.io.IOException,
                               AutomationException

Text symbol used to draw the layer name.

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGroupIndex

public int getGroupIndex()
                  throws java.io.IOException,
                         AutomationException

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

Specified by:

getGroupIndex in interface ILegendItem

Specified by:

getGroupIndex in interface ILegendItem2

Specified by:

getGroupIndex in interface ILegendItem3

Returns:

The index

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setGroupIndex

public void setGroupIndex(int index)
                   throws java.io.IOException,
                          AutomationException

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

Specified by:

setGroupIndex in interface ILegendItem

Specified by:

setGroupIndex in interface ILegendItem2

Specified by:

setGroupIndex in interface ILegendItem3

Parameters:

index - The index (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isShowHeading

public boolean isShowHeading()
                      throws java.io.IOException,
                             AutomationException

Indicates if heading is visibile.

Specified by:

isShowHeading in interface ILegendItem

Specified by:

isShowHeading in interface ILegendItem2

Specified by:

isShowHeading in interface ILegendItem3

Returns:

The showHeading

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setShowHeading

public void setShowHeading(boolean showHeading)
                    throws java.io.IOException,
                           AutomationException

Indicates if heading is visibile.

Specified by:

setShowHeading in interface ILegendItem

Specified by:

setShowHeading in interface ILegendItem2

Specified by:

setShowHeading in interface ILegendItem3

Parameters:

showHeading - The showHeading (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHeadingSymbol

public ITextSymbol getHeadingSymbol()
                             throws java.io.IOException,
                                    AutomationException

Text symbol used to draw the heading.

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHeadingSymbol

public void setHeadingSymbol(ITextSymbol symbol)
                      throws java.io.IOException,
                             AutomationException

Text symbol used to draw the heading.

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLegendClassFormat

public ILegendClassFormat getLegendClassFormat()
                                        throws java.io.IOException,
                                               AutomationException

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

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLegendClassFormat

public void setLegendClassFormat(ILegendClassFormat format)
                          throws java.io.IOException,
                                 AutomationException

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

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isShowLabels

public boolean isShowLabels()
                     throws java.io.IOException,
                            AutomationException

Indicates if labels are visible.

Specified by:

isShowLabels in interface ILegendItem

Specified by:

isShowLabels in interface ILegendItem2

Specified by:

isShowLabels in interface ILegendItem3

Returns:

The showLabels

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setShowLabels

public void setShowLabels(boolean showLabels)
                   throws java.io.IOException,
                          AutomationException

Indicates if labels are visible.

Specified by:

setShowLabels in interface ILegendItem

Specified by:

setShowLabels in interface ILegendItem2

Specified by:

setShowLabels in interface ILegendItem3

Parameters:

showLabels - The showLabels (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isShowDescriptions

public boolean isShowDescriptions()
                           throws java.io.IOException,
                                  AutomationException

Indicates if descriptions are visible.

Specified by:

isShowDescriptions in interface ILegendItem

Specified by:

isShowDescriptions in interface ILegendItem2

Specified by:

isShowDescriptions in interface ILegendItem3

Returns:

The showDescriptions

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setShowDescriptions

public void setShowDescriptions(boolean showDescriptions)
                         throws java.io.IOException,
                                AutomationException

Indicates if descriptions are visible.

Specified by:

setShowDescriptions in interface ILegendItem

Specified by:

setShowDescriptions in interface ILegendItem2

Specified by:

setShowDescriptions in interface ILegendItem3

Parameters:

showDescriptions - The showDescriptions (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createGraphics

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

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

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWidth

public double getWidth()
                throws java.io.IOException,
                       AutomationException

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

Specified by:

getWidth in interface ILegendItem

Specified by:

getWidth in interface ILegendItem2

Specified by:

getWidth in interface ILegendItem3

Returns:

The width

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHeight

public double getHeight()
                 throws java.io.IOException,
                        AutomationException

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

Specified by:

getHeight in interface ILegendItem

Specified by:

getHeight in interface ILegendItem2

Specified by:

getHeight in interface ILegendItem3

Returns:

The height

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGraphics

public IEnumElement getGraphics()
                         throws java.io.IOException,
                                AutomationException

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

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

esri_clone

public IClone esri_clone()
                  throws java.io.IOException,
                         AutomationException

Clones the receiver and assigns the result to *clone.

Specified by:

esri_clone in interface IClone

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws java.io.IOException,
                   AutomationException

Assigns the properties of src to the receiver.

Specified by:

assign in interface IClone

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws java.io.IOException,
                       AutomationException

Indicates if the receiver and other have the same properties.

Specified by:

isEqual in interface IClone

Parameters:

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

Returns:

The equal

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws java.io.IOException,
                           AutomationException

Indicates if the receiver and other are the same object.

Specified by:

isIdentical in interface IClone

Parameters:

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

Returns:

The identical

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws java.io.IOException,
                    AutomationException

isDirty

Specified by:

isDirty in interface IPersistStream

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException

load

Specified by:

load in interface IPersistStream

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

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

save

Specified by:

save in interface IPersistStream

Parameters:

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

fClearDirty - The fClearDirty (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

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

getSizeMax

Specified by:

getSizeMax in interface IPersistStream

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

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

getClassID

Specified by:

getClassID in interface IPersist

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

changeFlowDirection

public void changeFlowDirection(boolean rightToLeft)
                         throws java.io.IOException,
                                AutomationException

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

Specified by:

changeFlowDirection in interface ILegendItem2

Specified by:

changeFlowDirection in interface ILegendItem3

Parameters:

rightToLeft - The rightToLeft (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getReferenceScaleRatio

public double getReferenceScaleRatio()
                              throws java.io.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.

Specified by:

getReferenceScaleRatio in interface ILegendItem3

Returns:

The ratio

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReferenceScaleRatio

public void setReferenceScaleRatio(double ratio)
                            throws java.io.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.

Specified by:

setReferenceScaleRatio in interface ILegendItem3

Parameters:

ratio - The ratio (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSupportsTransparency

public boolean isSupportsTransparency()
                               throws java.io.IOException,
                                      AutomationException

Indicates if the layer supports transparency.

Specified by:

isSupportsTransparency in interface ILayerEffects

Returns:

The supported

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSupportsContrastChange

public boolean isSupportsContrastChange()
                                 throws java.io.IOException,
                                        AutomationException

Indicates if the layer supports contrast changes.

Specified by:

isSupportsContrastChange in interface ILayerEffects

Returns:

The supported

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSupportsBrightnessChange

public boolean isSupportsBrightnessChange()
                                   throws java.io.IOException,
                                          AutomationException

Indicates if the layer supports brightness changes.

Specified by:

isSupportsBrightnessChange in interface ILayerEffects

Returns:

The supported

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSupportsInteractive

public void setSupportsInteractive(boolean supported)
                            throws java.io.IOException,
                                   AutomationException

Indicates if the layer supports interactive effects changes.

Specified by:

setSupportsInteractive in interface ILayerEffects

Parameters:

supported - The supported (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSupportsInteractive

public boolean isSupportsInteractive()
                              throws java.io.IOException,
                                     AutomationException

Indicates if the layer supports interactive effects changes.

Specified by:

isSupportsInteractive in interface ILayerEffects

Returns:

The supported

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTransparency

public short getTransparency()
                      throws java.io.IOException,
                             AutomationException

Layer transparency in percent (0-100).

Specified by:

getTransparency in interface ILayerEffects

Returns:

The alpha

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTransparency

public void setTransparency(short alpha)
                     throws java.io.IOException,
                            AutomationException

Layer transparency in percent (0-100).

Specified by:

setTransparency in interface ILayerEffects

Parameters:

alpha - The alpha (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getContrast

public short getContrast()
                  throws java.io.IOException,
                         AutomationException

Layer contrast in percent (-100 - 100).

Specified by:

getContrast in interface ILayerEffects

Returns:

The contrastValue

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setContrast

public void setContrast(short contrastValue)
                 throws java.io.IOException,
                        AutomationException

Layer contrast in percent (-100 - 100).

Specified by:

setContrast in interface ILayerEffects

Parameters:

contrastValue - The contrastValue (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBrightness

public short getBrightness()
                    throws java.io.IOException,
                           AutomationException

Layer brightness in percent (-100 - 100).

Specified by:

getBrightness in interface ILayerEffects

Returns:

The brightnessValue

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBrightness

public void setBrightness(short brightnessValue)
                   throws java.io.IOException,
                          AutomationException

Layer brightness in percent (-100 - 100).

Specified by:

setBrightness in interface ILayerEffects

Parameters:

brightnessValue - The brightnessValue (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Throws:

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Throws:

java.io.IOException

java.lang.ClassNotFoundException