com.esri.arcgis.carto
Class LocatorRectangle

java.lang.Object
  extended by com.esri.arcgis.carto.LocatorRectangle
All Implemented Interfaces:
IFrameProperties, IGraphicsComposite, ILocatorRectangle, ILocatorRectangle2, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, java.io.Externalizable, java.io.Serializable

public class LocatorRectangle
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, ILocatorRectangle, ILocatorRectangle2, IFrameProperties, IGraphicsComposite, IPersistStream, IPersist, java.io.Externalizable

COM Class 'LocatorRectangle'. Generated 3/19/2015 1:20:41 PM from 'C:\ArcGIS\COM\esriCarto.olb'

Description 'A map 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 =

See Also:
Serialized Form

Field Summary
static long serialVersionUID
           
 
Fields inherited from interface com.esri.arcgis.carto.ILocatorRectangle
IID, IID41d9c095_a403_11d2_87e8_0000f8751720, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.ILocatorRectangle2
IID, IID41d9c096_a403_11d2_87e8_0000f8751720, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.IFrameProperties
IID, IIDd1b1b855_5885_4d7f_a444_a02e3e1078c3, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.IGraphicsComposite
IID, IID969cde4a_82d4_11d2_87dd_0000f8751720, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.IPersistStream
IID, IID00000109_0000_0000_c000_000000000046, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.IPersist
IID0000010c_0000_0000_c000_000000000046
 
Constructor Summary
LocatorRectangle()
          Constructs a LocatorRectangle using ArcGIS Engine.
LocatorRectangle(java.lang.Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
LocatorRectangle theLocatorRectangle = (LocatorRectangle) obj;
 
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.
 boolean equals(java.lang.Object o)
          Compare this object with another
 IBackground getBackground()
          The page background.
 IBorder getBorder()
          The page border.
 void getClassID(GUID[] pClassID)
          getClassID
static java.lang.String getClsid()
          getClsid.
 IEnumElement getGraphics(IDisplay display, java.lang.Object data)
          Graphic elements that are used to render this object.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 ISymbol getLeaderSymbol()
          The symbol used to render the leader line.
 IMapFrame getMapFrame()
          The map frame being referenced.
 IShadow getShadow()
          Frame shadow used by this element.
 void getSizeMax(_ULARGE_INTEGER[] pcbSize)
          getSizeMax
 int hashCode()
          the hashcode for this object
 IBackground IFrameProperties_getBackground()
          Frame background used by this element.
 void isDirty()
          isDirty
 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 load(IStream pstm)
          load
 void queryBounds(IDisplay display, IMapFrame parent, IEnvelope bounds)
          Returns the bounds of the locator.
 void readExternal(java.io.ObjectInput in)
           
 void release()
          Release a LocatorRectangle.
 void save(IStream pstm, int fClearDirty)
          save
 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 setShadow(IShadow shadow)
          Frame shadow used by this element.
 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.
 void writeExternal(java.io.ObjectOutput out)
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

serialVersionUID

public static final long serialVersionUID
See Also:
Constant Field Values
Constructor Detail

LocatorRectangle

public LocatorRectangle()
                 throws java.io.IOException,
                        java.net.UnknownHostException
Constructs a LocatorRectangle using ArcGIS Engine.

Throws:
java.io.IOException - if there are interop problems
java.net.UnknownHostException - if there are interop problems

LocatorRectangle

public LocatorRectangle(java.lang.Object obj)
                 throws java.io.IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
LocatorRectangle theLocatorRectangle = (LocatorRectangle) obj;

Construct a LocatorRectangle using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to LocatorRectangle.

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
java.io.IOException - if there are interop problems
Method Detail

getClsid

public static java.lang.String getClsid()
getClsid.


equals

public boolean equals(java.lang.Object o)
Compare this object with another

Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()
Deprecated. Internal use only.

Specified by:
getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()
Release a LocatorRectangle.

Specified by:
release in interface com.esri.arcgis.interop.RemoteObjRef

setMapFrameByRef

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

Specified by:
setMapFrameByRef in interface ILocatorRectangle
Specified by:
setMapFrameByRef in interface ILocatorRectangle2
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

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

Specified by:
getMapFrame in interface ILocatorRectangle
Specified by:
getMapFrame in interface ILocatorRectangle2
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

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

Specified by:
getBorder in interface IFrameProperties
Specified by:
getBorder in interface ILocatorRectangle
Specified by:
getBorder in interface ILocatorRectangle2
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

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

Specified by:
setBorder in interface IFrameProperties
Specified by:
setBorder in interface ILocatorRectangle
Specified by:
setBorder in interface ILocatorRectangle2
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

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

Specified by:
getBackground in interface ILocatorRectangle
Specified by:
getBackground in interface ILocatorRectangle2
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

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

Specified by:
setBackground in interface IFrameProperties
Specified by:
setBackground in interface ILocatorRectangle
Specified by:
setBackground in interface ILocatorRectangle2
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

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

Specified by:
setLeaderSymbol in interface ILocatorRectangle
Specified by:
setLeaderSymbol in interface ILocatorRectangle2
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

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

Specified by:
getLeaderSymbol in interface ILocatorRectangle
Specified by:
getLeaderSymbol in interface ILocatorRectangle2
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

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

Specified by:
isShowLeader in interface ILocatorRectangle
Specified by:
isShowLeader in interface ILocatorRectangle2
Returns:
The flag
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setShowLeader

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

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

queryBounds

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

Specified by:
queryBounds in interface ILocatorRectangle
Specified by:
queryBounds in interface ILocatorRectangle2
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

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

Specified by:
draw in interface ILocatorRectangle
Specified by:
draw in interface ILocatorRectangle2
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

public 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.

Specified by:
isUseSimpleExtent in interface ILocatorRectangle2
Returns:
The flag
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setUseSimpleExtent

public 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.

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

drawExtent

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

Specified by:
drawExtent in interface ILocatorRectangle2
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

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

Specified by:
drawLeader in interface ILocatorRectangle2
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.

IFrameProperties_getBackground

public IBackground IFrameProperties_getBackground()
                                           throws java.io.IOException,
                                                  AutomationException
Frame background used by this element.

Specified by:
IFrameProperties_getBackground in interface IFrameProperties
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.

getShadow

public IShadow getShadow()
                  throws java.io.IOException,
                         AutomationException
Frame shadow used by this element.

Specified by:
getShadow in interface IFrameProperties
Returns:
A reference to a com.esri.arcgis.carto.IShadow
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setShadow

public void setShadow(IShadow shadow)
               throws java.io.IOException,
                      AutomationException
Frame shadow used by this element.

Specified by:
setShadow in interface IFrameProperties
Parameters:
shadow - A reference to a com.esri.arcgis.carto.IShadow (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getGraphics

public IEnumElement getGraphics(IDisplay display,
                                java.lang.Object data)
                         throws java.io.IOException,
                                AutomationException
Graphic elements that are used to render this object. The data argument is defined by the coclass that implements this interface.

Specified by:
getGraphics in interface IGraphicsComposite
Parameters:
display - A reference to a com.esri.arcgis.display.IDisplay (in)
data - A reference to another Object (IUnknown) (in)
Returns:
A reference to a com.esri.arcgis.carto.IEnumElement
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isDirty

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

Specified by:
isDirty in interface IPersistStream
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException
load

Specified by:
load in interface IPersistStream
Parameters:
pstm - A reference to a com.esri.arcgis.system.IStream (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws java.io.IOException,
                 AutomationException
save

Specified by:
save in interface IPersistStream
Parameters:
pstm - A reference to a com.esri.arcgis.system.IStream (in)
fClearDirty - The fClearDirty (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws java.io.IOException,
                       AutomationException
getSizeMax

Specified by:
getSizeMax in interface IPersistStream
Parameters:
pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws java.io.IOException,
                       AutomationException
getClassID

Specified by:
getClassID in interface IPersist
Parameters:
pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException
Specified by:
writeExternal in interface java.io.Externalizable
Throws:
java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException
Specified by:
readExternal in interface java.io.Externalizable
Throws:
java.io.IOException
java.lang.ClassNotFoundException