com.esri.arcgis.trackinganalyst
Interface ITemporalLegendGroup

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

ITemporalLegendGroup2

All Known Implementing Classes:

ITemporalLegendGroup2Proxy, ITemporalLegendGroupProxy, TemporalLegendGroup

public interface ITemporalLegendGroup
extends java.io.Serializable

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 =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IIDb75d7088_1333_11d5_b7c9_00010265adc5
static int	xxDummy Deprecated. Internal use only

Method Summary

void	addClass(ILegendClass legendClass) Adds a new legend class to the group at the end of list.
void	clearClasses() Removes all classes from the group.
ILegendClass	esri_getClass(int index) Legend class at the specified index.
int	getClassCount() Number of legend classes in the group.
java.lang.String	getColorRampName() 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() Text description of the temporal legend group.
java.lang.String	getHeading() String heading.
ITemporalLegendClass	getTemporalLegendClass(int nRangeNdx) Temporal Legend Class at specified index from this group.
void	insertClass(int index, ILegendClass legendClass) Inserts a new legend class into the group at the specified index.
int	intersects(java.lang.Object pvTimeValue, ISymbol[] ppiSymbol, IColor[] ppiSymbolColor, double[] pdSymbolSize) Determines whether a given timestamp value is contained within one of the group's temporal classes.
boolean	isEditable() Indicates if the group can be edited.
boolean	isSuppress() Controls whether or not to use the temporal legend classes during intersect or time period computation for a temporal query.
boolean	isVisible() Indicates if the group is displayed.
void	moveClass(int nCurrentIndex, int nDestinationIndex) 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) Removes the legend class from the group at the specified index.
void	setColorRampName(java.lang.String pbstrColorRampName) 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) Text description of the temporal legend group.
void	setEditable(boolean editable) Indicates if the group can be edited.
void	setHeading(java.lang.String heading) String heading.
void	setReference(java.lang.Object varReference) Sets temporal reference information for the temporal legend group.
void	setSuppress(boolean pbSuppress) Controls whether or not to use the temporal legend classes during intersect or time period computation for a temporal query.
void	setVisible(boolean visible) Indicates if the group is displayed.
void	update() Updates the temporal legend with new values.
void	verify(boolean[] bNoProblems) Checks ranges within a group to determine if group is ordered properly and has correct offsets.

Field Detail

IIDb75d7088_1333_11d5_b7c9_00010265adc5

static final int IIDb75d7088_1333_11d5_b7c9_00010265adc5

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

isVisible

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

Indicates if the group is displayed.

Returns:

The visible

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setVisible

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

Indicates if the group is displayed.

Parameters:

visible - The visible (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isEditable

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

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

Returns:

The editable

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setEditable

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

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

Parameters:

editable - The editable (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHeading

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

String heading.

Returns:

The heading

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setHeading

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

String heading.

Parameters:

heading - The heading (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getClassCount

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

Number of legend classes in the group.

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

esri_getClass

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

Legend class at the specified index.

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

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

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

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

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

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

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

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

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

Parameters:

index - The index (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

clearClasses

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

Removes all classes from the group.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getColorRampName

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

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.

Returns:

The pbstrColorRampName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setColorRampName

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

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.

Parameters:

pbstrColorRampName - The pbstrColorRampName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDescription

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

Text description of the temporal legend group.

Returns:

The pbstrDescription

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDescription

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

Text description of the temporal legend group.

Parameters:

pbstrDescription - The pbstrDescription (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTemporalLegendClass

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

Temporal Legend Class at specified index from this group.

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

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

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

Returns:

The pbSuppress

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSuppress

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

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

Parameters:

pbSuppress - The pbSuppress (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setReference

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

Sets temporal reference information for the temporal legend group.

Parameters:

varReference - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

intersects

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

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

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

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

Updates the temporal legend with new values.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

moveClass

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

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

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

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

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

Parameters:

bNoProblems - The bNoProblems (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.