com.esri.arcgis.carto
Class LocatorRectangle

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

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

A map locator rectangle.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
Serialized Form

Constructor Summary
LocatorRectangle()
          Constructs a LocatorRectangle using ArcGIS Engine.
LocatorRectangle(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)
          Draws the locator rectangle.
 boolean equals(Object o)
          Compare this object with another
 IBackground getBackground()
          The page background.
 IBorder getBorder()
          The page border.
 void getClassID(GUID[] pClassID)
          getClassID
static String getClsid()
          getClsid.
 IEnumElement getGraphics(IDisplay display, Object data)
          Graphic elements that are used to render this object.
 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.
 void load(IStream pstm)
          load
 void queryBounds(IDisplay display, IMapFrame parent, IEnvelope bounds)
          Returns the bounds of the locator.
 void readExternal(ObjectInput in)
           
 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 writeExternal(ObjectOutput out)
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef
getJintegraDispatch, release
 

Constructor Detail

LocatorRectangle

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

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

LocatorRectangle

public LocatorRectangle(Object obj)
                 throws 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:
IOException - if there are interop problems
Method Detail

getClsid

public static String getClsid()
getClsid.


equals

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

Overrides:
equals in class Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class Object

setMapFrameByRef

public 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

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

public 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

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

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

public 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

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

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

public 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

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

public 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

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

public 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

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

public 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

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

setShowLeader

public 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

Specified by:
setShowLeader in interface ILocatorRectangle
Parameters:
flag - The flag (in)
Throws:
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 IOException,
                        AutomationException
Returns the bounds of the locator.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

public 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

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

IFrameProperties_getBackground

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

Product Availability

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

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

getShadow

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setShadow

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getGraphics

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

Product Availability

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

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

isDirty

public void isDirty()
             throws IOException,
                    AutomationException
isDirty

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException
load

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

save

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

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getSizeMax

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

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getClassID

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

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

writeExternal

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

readExternal

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