com.esri.arcgis.display
Interface ITimeDisplay

All Superinterfaces:

Serializable

All Known Implementing Classes:

ITimeDisplayProxy, ScreenDisplay, SimpleDisplay

public interface ITimeDisplay
extends Serializable

Provides access to members that control the Time Extent.

Description

This interface allows the Display to respond to programmatic commands that change the currently displayed time. All layers participating in the Time system will respond to commands sent to this Display interface.

Product Availability

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

Method Summary

ITimeReference	getTimeReference() Time reference using which the data has to be displayed.
ITimeValue	getTimeValue() Time Extent for which the data has to be displayed.
void	setTimeReference(ITimeReference timeReference) Time reference using which the data has to be displayed.
void	setTimeValue(ITimeValue timeExtent) Time Extent for which the data has to be displayed.

Method Detail

getTimeValue

ITimeValue getTimeValue()
                        throws IOException,
                               AutomationException

Time Extent for which the data has to be displayed.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTimeValue

void setTimeValue(ITimeValue timeExtent)
                  throws IOException,
                         AutomationException

Time Extent for which the data has to be displayed.

Product Availability

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

Parameters:

timeExtent - A reference to a com.esri.arcgis.system.ITimeValue (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTimeReference

ITimeReference getTimeReference()
                                throws IOException,
                                       AutomationException

Time reference using which the data has to be displayed.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTimeReference

void setTimeReference(ITimeReference timeReference)
                      throws IOException,
                             AutomationException

Time reference using which the data has to be displayed.

Product Availability

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

Parameters:

timeReference - A reference to a com.esri.arcgis.system.ITimeReference (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.