com.esri.arcgis.trackinganalyst
Class ITemporalLegendGroupProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.trackinganalyst.ITemporalLegendGroupProxy

All Implemented Interfaces:

ITemporalLegendGroup, java.io.Externalizable, java.io.Serializable

Direct Known Subclasses:

ITemporalLegendGroup2Proxy

Deprecated. Internal use only. Proxy for COM Interface 'ITemporalLegendGroup'. Generated 3/19/2015 1:20:59 PM from 'C:\ArcGIS\COM\esriTrackingAnalyst.olb'

Description: 'Provides access to properties and methods needed to manage the temporal legend group of classes.' 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 =

public class ITemporalLegendGroupProxy
extends com.esri.arcgis.interop.Dispatch
implements ITemporalLegendGroup, java.io.Serializable

Internal use class

See Also:

Serialized Form

Field Summary

boolean	noncastable Deprecated.
static java.lang.Class	targetClass Deprecated.

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

Fields inherited from interface com.esri.arcgis.trackinganalyst.ITemporalLegendGroup

IID, IIDb75d7088_1333_11d5_b7c9_00010265adc5

Constructor Summary

	ITemporalLegendGroupProxy() Deprecated. For internal use only
	ITemporalLegendGroupProxy(java.lang.Object obj) Deprecated.
protected	ITemporalLegendGroupProxy(java.lang.Object obj, java.lang.String iid) Deprecated.
	ITemporalLegendGroupProxy(java.lang.String CLSID, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo) Deprecated.
protected	ITemporalLegendGroupProxy(java.lang.String CLSID, java.lang.String iid, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo) Deprecated.

Method Summary

void	addClass(ILegendClass legendClass) Deprecated. Adds a new legend class to the group at the end of list.
void	addListener(java.lang.String iidStr, java.lang.Object theListener, java.lang.Object theSource) Deprecated.
void	clearClasses() Deprecated. Removes all classes from the group.
ILegendClass	esri_getClass(int index) Deprecated. Legend class at the specified index.
int	getClassCount() Deprecated. Number of legend classes in the group.
java.lang.String	getColorRampName() Deprecated. Esri pre-defined color ramp last used by the temporal renderer property page to update this object; this value is used to create default temporal legend class symbology colors.
java.lang.String	getDescription() Deprecated. Text description of the temporal legend group.
java.lang.String	getHeading() Deprecated. String heading.
ITemporalLegendClass	getTemporalLegendClass(int nRangeNdx) Deprecated. Temporal Legend Class at specified index from this group.
void	insertClass(int index, ILegendClass legendClass) Deprecated. Inserts a new legend class into the group at the specified index.
int	intersects(java.lang.Object pvTimeValue, ISymbol[] ppiSymbol, IColor[] ppiSymbolColor, double[] pdSymbolSize) Deprecated. Determines whether a given timestamp value is contained within one of the group's temporal classes.
boolean	isEditable() Deprecated. Indicates if the group can be edited.
boolean	isSuppress() Deprecated. Controls whether or not to use the temporal legend classes during intersect or time period computation for a temporal query.
boolean	isVisible() Deprecated. Indicates if the group is displayed.
void	moveClass(int nCurrentIndex, int nDestinationIndex) Deprecated. Moves a temporal legend class from its current position to a new destination within the temporal legend group's legend class container.
void	removeClass(int index) Deprecated. Removes the legend class from the group at the specified index.
void	removeListener(java.lang.String iidStr, java.lang.Object theListener) Deprecated.
void	setColorRampName(java.lang.String pbstrColorRampName) Deprecated. Esri pre-defined color ramp last used by the temporal renderer property page to update this object; this value is used to create default temporal legend class symbology colors.
void	setDescription(java.lang.String pbstrDescription) Deprecated. Text description of the temporal legend group.
void	setEditable(boolean editable) Deprecated. Indicates if the group can be edited.
void	setHeading(java.lang.String heading) Deprecated. String heading.
void	setReference(java.lang.Object varReference) Deprecated. Sets temporal reference information for the temporal legend group.
void	setSuppress(boolean pbSuppress) Deprecated. Controls whether or not to use the temporal legend classes during intersect or time period computation for a temporal query.
void	setVisible(boolean visible) Deprecated. Indicates if the group is displayed.
void	update() Deprecated. Updates the temporal legend with new values.
void	verify(boolean[] bNoProblems) Deprecated. Checks ranges within a group to determine if group is ordered properly and has correct offsets.

Methods inherited from class com.esri.arcgis.interop.Dispatch

bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal

Methods inherited from class java.lang.Object

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

Field Detail

targetClass

public static final java.lang.Class targetClass

Deprecated.

noncastable

public boolean noncastable

Deprecated.

Constructor Detail

ITemporalLegendGroupProxy

public ITemporalLegendGroupProxy(java.lang.String CLSID,
                                 java.lang.String host,
                                 com.esri.arcgis.interop.AuthInfo authInfo)
                          throws java.net.UnknownHostException,
                                 java.io.IOException

Deprecated.

Throws:

java.net.UnknownHostException

java.io.IOException

ITemporalLegendGroupProxy

public ITemporalLegendGroupProxy()

Deprecated.

For internal use only

ITemporalLegendGroupProxy

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

Deprecated.

Throws:

java.io.IOException

ITemporalLegendGroupProxy

protected ITemporalLegendGroupProxy(java.lang.Object obj,
                                    java.lang.String iid)
                             throws java.io.IOException

Deprecated.

Throws:

java.io.IOException

ITemporalLegendGroupProxy

protected ITemporalLegendGroupProxy(java.lang.String CLSID,
                                    java.lang.String iid,
                                    java.lang.String host,
                                    com.esri.arcgis.interop.AuthInfo authInfo)
                             throws java.io.IOException

Deprecated.

Throws:

java.io.IOException

Method Detail

addListener

public void addListener(java.lang.String iidStr,
                        java.lang.Object theListener,
                        java.lang.Object theSource)
                 throws java.io.IOException

Deprecated.

Overrides:

addListener in class com.esri.arcgis.interop.Dispatch

Throws:

java.io.IOException

removeListener

public void removeListener(java.lang.String iidStr,
                           java.lang.Object theListener)
                    throws java.io.IOException

Deprecated.

Overrides:

removeListener in class com.esri.arcgis.interop.Dispatch

Throws:

java.io.IOException

isVisible

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

Deprecated.

Indicates if the group is displayed.

Specified by:

isVisible in interface ITemporalLegendGroup

Returns:

The visible

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setVisible

public void setVisible(boolean visible)
                throws java.io.IOException,
                       AutomationException

Deprecated.

Indicates if the group is displayed.

Specified by:

setVisible in interface ITemporalLegendGroup

Parameters:

visible - The visible (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isEditable

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

Deprecated.

Indicates if the group can be edited. Default is editable.

Specified by:

isEditable in interface ITemporalLegendGroup

Returns:

The editable

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setEditable

public void setEditable(boolean editable)
                 throws java.io.IOException,
                        AutomationException

Deprecated.

Indicates if the group can be edited. Default is editable.

Specified by:

setEditable in interface ITemporalLegendGroup

Parameters:

editable - The editable (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHeading

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

Deprecated.

String heading.

Specified by:

getHeading in interface ITemporalLegendGroup

Returns:

The heading

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setHeading

public void setHeading(java.lang.String heading)
                throws java.io.IOException,
                       AutomationException

Deprecated.

String heading.

Specified by:

setHeading in interface ITemporalLegendGroup

Parameters:

heading - The heading (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getClassCount

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

Deprecated.

Number of legend classes in the group.

Specified by:

getClassCount in interface ITemporalLegendGroup

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

esri_getClass

public ILegendClass esri_getClass(int index)
                           throws java.io.IOException,
                                  AutomationException

Deprecated.

Legend class at the specified index.

Specified by:

esri_getClass in interface ITemporalLegendGroup

Parameters:

index - The index (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addClass

public void addClass(ILegendClass legendClass)
              throws java.io.IOException,
                     AutomationException

Deprecated.

Adds a new legend class to the group at the end of list.

Specified by:

addClass in interface ITemporalLegendGroup

Parameters:

legendClass - A reference to a com.esri.arcgis.carto.ILegendClass (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

insertClass

public void insertClass(int index,
                        ILegendClass legendClass)
                 throws java.io.IOException,
                        AutomationException

Deprecated.

Inserts a new legend class into the group at the specified index.

Specified by:

insertClass in interface ITemporalLegendGroup

Parameters:

index - The index (in)

legendClass - A reference to a com.esri.arcgis.carto.ILegendClass (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

removeClass

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

Deprecated.

Removes the legend class from the group at the specified index.

Specified by:

removeClass in interface ITemporalLegendGroup

Parameters:

index - The index (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

clearClasses

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

Deprecated.

Removes all classes from the group.

Specified by:

clearClasses in interface ITemporalLegendGroup

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getColorRampName

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

Deprecated.

Esri pre-defined color ramp last used by the temporal renderer property page to update this object; this value is used to create default temporal legend class symbology colors.

Specified by:

getColorRampName in interface ITemporalLegendGroup

Returns:

The pbstrColorRampName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setColorRampName

public void setColorRampName(java.lang.String pbstrColorRampName)
                      throws java.io.IOException,
                             AutomationException

Deprecated.

Esri pre-defined color ramp last used by the temporal renderer property page to update this object; this value is used to create default temporal legend class symbology colors.

Specified by:

setColorRampName in interface ITemporalLegendGroup

Parameters:

pbstrColorRampName - The pbstrColorRampName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDescription

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

Deprecated.

Text description of the temporal legend group.

Specified by:

getDescription in interface ITemporalLegendGroup

Returns:

The pbstrDescription

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDescription

public void setDescription(java.lang.String pbstrDescription)
                    throws java.io.IOException,
                           AutomationException

Deprecated.

Text description of the temporal legend group.

Specified by:

setDescription in interface ITemporalLegendGroup

Parameters:

pbstrDescription - The pbstrDescription (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTemporalLegendClass

public ITemporalLegendClass getTemporalLegendClass(int nRangeNdx)
                                            throws java.io.IOException,
                                                   AutomationException

Deprecated.

Temporal Legend Class at specified index from this group.

Specified by:

getTemporalLegendClass in interface ITemporalLegendGroup

Parameters:

nRangeNdx - The nRangeNdx (in)

Returns:

A reference to a com.esri.arcgis.trackinganalyst.ITemporalLegendClass

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isSuppress

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

Deprecated.

Controls whether or not to use the temporal legend classes during intersect or time period computation for a temporal query.

Specified by:

isSuppress in interface ITemporalLegendGroup

Returns:

The pbSuppress

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSuppress

public void setSuppress(boolean pbSuppress)
                 throws java.io.IOException,
                        AutomationException

Deprecated.

Controls whether or not to use the temporal legend classes during intersect or time period computation for a temporal query.

Specified by:

setSuppress in interface ITemporalLegendGroup

Parameters:

pbSuppress - The pbSuppress (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setReference

public void setReference(java.lang.Object varReference)
                  throws java.io.IOException,
                         AutomationException

Deprecated.

Sets temporal reference information for the temporal legend group.

Specified by:

setReference in interface ITemporalLegendGroup

Parameters:

varReference - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

intersects

public int intersects(java.lang.Object pvTimeValue,
                      ISymbol[] ppiSymbol,
                      IColor[] ppiSymbolColor,
                      double[] pdSymbolSize)
               throws java.io.IOException,
                      AutomationException

Deprecated.

Determines whether a given timestamp value is contained within one of the group's temporal classes.

Specified by:

intersects in interface ITemporalLegendGroup

Parameters:

pvTimeValue - A Variant (in)

ppiSymbol - A reference to a com.esri.arcgis.display.ISymbol (in/out: use single element array)

ppiSymbolColor - A reference to a com.esri.arcgis.display.IColor (in/out: use single element array)

pdSymbolSize - The pdSymbolSize (in/out: use single element array)

Returns:

The pnUseSymbol

Throws:

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

AutomationException - If the ArcObject component throws an exception.

update

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

Deprecated.

Updates the temporal legend with new values.

Specified by:

update in interface ITemporalLegendGroup

Throws:

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

AutomationException - If the ArcObject component throws an exception.

moveClass

public void moveClass(int nCurrentIndex,
                      int nDestinationIndex)
               throws java.io.IOException,
                      AutomationException

Deprecated.

Moves a temporal legend class from its current position to a new destination within the temporal legend group's legend class container.

Specified by:

moveClass in interface ITemporalLegendGroup

Parameters:

nCurrentIndex - The nCurrentIndex (in)

nDestinationIndex - The nDestinationIndex (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

verify

public void verify(boolean[] bNoProblems)
            throws java.io.IOException,
                   AutomationException

Deprecated.

Checks ranges within a group to determine if group is ordered properly and has correct offsets.

Specified by:

verify in interface ITemporalLegendGroup

Parameters:

bNoProblems - The bNoProblems (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.