com.esri.arcgis.carto
Interface ILocatorRectangle

All Superinterfaces:
Serializable
All Known Implementing Classes:
LocatorRectangle

public interface ILocatorRectangle
extends Serializable

Provides access to the members that control the map frame locator rectangle.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 void draw(IDisplay display, IMapFrame parent)
          Draws the locator rectangle.
 IBackground getBackground()
          The page background.
 IBorder getBorder()
          The page border.
 ISymbol getLeaderSymbol()
          The symbol used to render the leader line.
 IMapFrame getMapFrame()
          The map frame being referenced.
 boolean isShowLeader()
          Indicates if leader lines should be drawn.
 void queryBounds(IDisplay display, IMapFrame parent, IEnvelope bounds)
          Returns the bounds of the locator.
 void setBackground(IBackground background)
          The page background.
 void setBorder(IBorder border)
          The page border.
 void setLeaderSymbol(ISymbol symbol)
          The symbol used to render the leader line.
 void setMapFrameByRef(IMapFrame mapFrame)
          The map frame being referenced.
 void setShowLeader(boolean flag)
          Indicates if leader lines should be drawn.
 

Method Detail

setMapFrameByRef

void setMapFrameByRef(IMapFrame mapFrame)
                      throws IOException,
                             AutomationException
The map frame being referenced.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
mapFrame - A reference to a com.esri.arcgis.carto.IMapFrame (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMapFrame

IMapFrame getMapFrame()
                      throws IOException,
                             AutomationException
The map frame being referenced.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A reference to a com.esri.arcgis.carto.IMapFrame
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBorder

IBorder getBorder()
                  throws IOException,
                         AutomationException
The page border.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A reference to a com.esri.arcgis.carto.IBorder
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBorder

void setBorder(IBorder border)
               throws IOException,
                      AutomationException
The page border.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
border - A reference to a com.esri.arcgis.carto.IBorder (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBackground

IBackground getBackground()
                          throws IOException,
                                 AutomationException
The page background.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A reference to a com.esri.arcgis.carto.IBackground
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBackground

void setBackground(IBackground background)
                   throws IOException,
                          AutomationException
The page background.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
background - A reference to a com.esri.arcgis.carto.IBackground (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLeaderSymbol

void setLeaderSymbol(ISymbol symbol)
                     throws IOException,
                            AutomationException
The symbol used to render the leader line.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
symbol - A reference to a com.esri.arcgis.display.ISymbol (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLeaderSymbol

ISymbol getLeaderSymbol()
                        throws IOException,
                               AutomationException
The symbol used to render the leader line.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A reference to a com.esri.arcgis.display.ISymbol
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isShowLeader

boolean isShowLeader()
                     throws IOException,
                            AutomationException
Indicates if leader lines should be drawn.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The flag
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setShowLeader

void setShowLeader(boolean flag)
                   throws IOException,
                          AutomationException
Indicates if leader lines should be drawn.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
flag - The flag (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryBounds

void queryBounds(IDisplay display,
                 IMapFrame parent,
                 IEnvelope bounds)
                 throws IOException,
                        AutomationException
Returns the bounds of the locator.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
display - A reference to a com.esri.arcgis.display.IDisplay (in)
parent - A reference to a com.esri.arcgis.carto.IMapFrame (in)
bounds - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

draw

void draw(IDisplay display,
          IMapFrame parent)
          throws IOException,
                 AutomationException
Draws the locator rectangle.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
display - A reference to a com.esri.arcgis.display.IDisplay (in)
parent - A reference to a com.esri.arcgis.carto.IMapFrame (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.