com.esri.arcgis.editor
Class ConstructionMiniBar

java.lang.Object
  extended by com.esri.arcgis.editor.ConstructionMiniBar
All Implemented Interfaces:
IConstructionMiniBar, IConstructionMiniBar2, com.esri.arcgis.interop.RemoteObjRef, IExtension, Serializable

public class ConstructionMiniBar
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IExtension, IConstructionMiniBar, IConstructionMiniBar2

An editor extension for working with the feature construction mini toobar

Product Availability

Available with ArcGIS Desktop.

See Also:
Serialized Form

Field Summary
 
Fields inherited from interface com.esri.arcgis.system.IExtension
IID, IID7f657ec9_dbf1_11d2_9f2f_00c04f6bc69e, xxDummy
 
Constructor Summary
ConstructionMiniBar()
          Constructs a ConstructionMiniBar using ArcGIS Engine.
ConstructionMiniBar(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ConstructionMiniBar theConstructionMiniBar = (ConstructionMiniBar) obj;
 
Method Summary
 boolean equals(Object o)
          Compare this object with another
static String getClsid()
          getClsid.
 String getName()
          The name of the extension.
 int hashCode()
          the hashcode for this object
 void hide()
          Hides the construction minibar.
 boolean isVisible()
          Indicates whether the construction minibar is visible.
 void processKeyDown(int keyState, int shift)
          Processes keyboard input.
 void setActive(boolean rhs1)
          Activate/Deactivate the Construction Minibar.
 void show(int xLoc, int yLoc)
          Shows the construction minibar.
 void showEx(int xLoc, int yLoc, int location)
          Shows the construction minibar.
 void shutdown()
          Shuts down the extension.
 void startup(Object initializationData)
          Starts up the extension with the given initialization data.
 void updateTransparency(int xLoc, int yLoc)
          Updates the coordinate display and adjusts the tranparency of the window.
 
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

ConstructionMiniBar

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

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

ConstructionMiniBar

public ConstructionMiniBar(Object obj)
                    throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ConstructionMiniBar theConstructionMiniBar = (ConstructionMiniBar) obj;

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

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

getName

public String getName()
               throws IOException,
                      AutomationException
The name of the extension.

Specified by:
getName in interface IExtension
Returns:
The extensionName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

startup

public void startup(Object initializationData)
             throws IOException,
                    AutomationException
Starts up the extension with the given initialization data.

Specified by:
startup in interface IExtension
Parameters:
initializationData - A Variant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

shutdown

public void shutdown()
              throws IOException,
                     AutomationException
Shuts down the extension.

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

show

public void show(int xLoc,
                 int yLoc)
          throws IOException,
                 AutomationException
Shows the construction minibar.

Product Availability

Available with ArcGIS Desktop.

Specified by:
show in interface IConstructionMiniBar
Parameters:
xLoc - The xLoc (in)
yLoc - The yLoc (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

hide

public void hide()
          throws IOException,
                 AutomationException
Hides the construction minibar.

Product Availability

Available with ArcGIS Desktop.

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

isVisible

public boolean isVisible()
                  throws IOException,
                         AutomationException
Indicates whether the construction minibar is visible.

Product Availability

Available with ArcGIS Desktop.

Specified by:
isVisible in interface IConstructionMiniBar
Returns:
The vis
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

updateTransparency

public void updateTransparency(int xLoc,
                               int yLoc)
                        throws IOException,
                               AutomationException
Updates the coordinate display and adjusts the tranparency of the window.

Product Availability

Available with ArcGIS Desktop.

Specified by:
updateTransparency in interface IConstructionMiniBar
Parameters:
xLoc - The xLoc (in)
yLoc - The yLoc (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

processKeyDown

public void processKeyDown(int keyState,
                           int shift)
                    throws IOException,
                           AutomationException
Processes keyboard input.

Product Availability

Available with ArcGIS Desktop.

Specified by:
processKeyDown in interface IConstructionMiniBar
Parameters:
keyState - The keyState (in)
shift - The shift (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setActive

public void setActive(boolean rhs1)
               throws IOException,
                      AutomationException
Activate/Deactivate the Construction Minibar.

Product Availability

Available with ArcGIS Desktop.

Specified by:
setActive in interface IConstructionMiniBar
Parameters:
rhs1 - The rhs1 (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

showEx

public void showEx(int xLoc,
                   int yLoc,
                   int location)
            throws IOException,
                   AutomationException
Shows the construction minibar.

Product Availability

Available with ArcGIS Desktop.

Specified by:
showEx in interface IConstructionMiniBar2
Parameters:
xLoc - The xLoc (in)
yLoc - The yLoc (in)
location - A com.esri.arcgis.editor.esriConstructionToolbarLocation constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.