Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.esri.arcgis.carto
Interface ILocatorRectangle2

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
ILocatorRectangle2Proxy, LocatorRectangle
public interface ILocatorRectangle2
extends java.io.Serializable

COM Interface 'ILocatorRectangle2'. Generated 3/19/2015 1:20:53 PM from 'C:\ArcGIS\COM\esriCarto.olb'

Description: 'Provides access to the members that control the map frame locator rectangle.' 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 IID41d9c096_a403_11d2_87e8_0000f8751720
           
static int xxDummy
          Deprecated. Internal use only
 
Method Summary
 void draw(IDisplay display, IMapFrame parent)
          Obsolete.
 void drawExtent(IDisplay mapDisplay, IMapFrame parent)
          Draws the locator shape on the Map display.
 void drawLeader(IDisplay layoutDisplay, IMapFrame parent)
          Draws the leader line on the Layout display.
 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.
 boolean isUseSimpleExtent()
          Use other data frame extent even if clipping is set or data driven pages are enabled.
 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.
 void setUseSimpleExtent(boolean flag)
          Use other data frame extent even if clipping is set or data driven pages are enabled.
 

Field Detail

IID41d9c096_a403_11d2_87e8_0000f8751720

static final int IID41d9c096_a403_11d2_87e8_0000f8751720
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

setMapFrameByRef

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

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

getMapFrame

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

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

getBorder

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

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

setBorder

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

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

getBackground

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

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

setBackground

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

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

setLeaderSymbol

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

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

getLeaderSymbol

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

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

isShowLeader

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

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

setShowLeader

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

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

queryBounds

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

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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

draw

void draw(IDisplay display,
          IMapFrame parent)
          throws java.io.IOException,
                 AutomationException
Obsolete. Use DrawExtent and DrawLeader instead.

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

isUseSimpleExtent

boolean isUseSimpleExtent()
                          throws java.io.IOException,
                                 AutomationException
Use other data frame extent even if clipping is set or data driven pages are enabled. By default, the clip or DDP shape is used.

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

setUseSimpleExtent

void setUseSimpleExtent(boolean flag)
                        throws java.io.IOException,
                               AutomationException
Use other data frame extent even if clipping is set or data driven pages are enabled. By default, the clip or DDP shape is used.

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

drawExtent

void drawExtent(IDisplay mapDisplay,
                IMapFrame parent)
                throws java.io.IOException,
                       AutomationException
Draws the locator shape on the Map display.

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

drawLeader

void drawLeader(IDisplay layoutDisplay,
                IMapFrame parent)
                throws java.io.IOException,
                       AutomationException
Draws the leader line on the Layout display.

Parameters:
layoutDisplay - A reference to a com.esri.arcgis.display.IDisplay (in)
parent - A reference to a com.esri.arcgis.carto.IMapFrame (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD