com.esri.arcgis.editor.PolygonFeatureTool
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Object
public class PolygonFeatureTool
Tool that creates a new Polygon sketch geometry.
| Constructor Summary | |
|---|---|
PolygonFeatureTool()
Constructs a PolygonFeatureTool using ArcGIS Engine. |
|
PolygonFeatureTool(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. PolygonFeatureTool thePolygonFeatureTool = (PolygonFeatureTool) obj; |
|
| Method Summary | |
|---|---|
boolean |
deactivate()
Causes the tool to no longer be the active tool. |
boolean |
equals(Object o)
Compare this object with another |
int |
getBitmap()
The bitmap that is used as the icon on this command. |
String |
getCaption()
The caption of this command. |
String |
getCategory()
The name of the category with which this command is associated. |
static String |
getClsid()
getClsid. |
int |
getCursor()
The mouse pointer for this tool. |
int |
getHelpContextID()
The help context ID associated with this command. |
String |
getHelpFile()
The name of the help file associated with this command. |
String |
getMessage()
The statusbar message for this command. |
String |
getName()
The name of this commmand. |
String |
getTooltip()
The tooltip for this command. |
int |
hashCode()
the hashcode for this object |
boolean |
isChecked()
Indicates if this command is checked. |
boolean |
isEnabled()
Indicates if this command is enabled. |
void |
onClick()
Occurs when this command is clicked. |
boolean |
onContextMenu(int x,
int y)
Context menu event occured at the given xy location. |
void |
onCreate(Object hook)
Occurs when this command is created. |
void |
onDblClick()
Occurs when a mouse button is double clicked when this tool is active. |
void |
onKeyDown(int keyCode,
int shift)
Occurs when a key on the keyboard is pressed when this tool is active. |
void |
onKeyUp(int keyCode,
int shift)
Occurs when a key on the keyboard is released when this tool is active. |
void |
onMouseDown(int button,
int shift,
int x,
int y)
Occurs when a mouse button is pressed when this tool is active. |
void |
onMouseMove(int button,
int shift,
int x,
int y)
Occurs when the mouse is moved when this tool is active. |
void |
onMouseUp(int button,
int shift,
int x,
int y)
Occurs when a mouse button is released when this tool is active. |
void |
refresh(int hdc)
Occurs when a screen display in the application is refreshed. |
| 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 |
|---|
public PolygonFeatureTool()
throws IOException,
UnknownHostException
IOException - if there are interop problems
UnknownHostException - if there are interop problems
public PolygonFeatureTool(Object obj)
throws IOException
PolygonFeatureTool thePolygonFeatureTool = (PolygonFeatureTool) obj;
obj to PolygonFeatureTool.
obj - an object returned from ArcGIS Engine or Server
IOException - if there are interop problems| Method Detail |
|---|
public static String getClsid()
public boolean equals(Object o)
equals in class Objectpublic int hashCode()
hashCode in class Object
public int getCursor()
throws IOException,
AutomationException
When implementing ITool to create a custom tool, use the Cursor property to set the mouse pointer of the tool.
getCursor in interface IToolIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void onMouseDown(int button,
int shift,
int x,
int y)
throws IOException,
AutomationException
button specifies which mouse button is pressed. The button argument is a bit field. Some, all, or none of the bits can be set indicating that some, all, or none of the mouse buttons are pressed. The values for button are as follows:
1 Left button
2 Right button
3 Left and Right buttons
4 Middle button
5 Left and Middle buttons
6 Right and Middle buttons
7 All buttons
Shift indicates whether the Shift key, Ctrl key, or Alt key is pressed when the mouse button is pressed. The Shift argument is a bit field. Some, all, or none of the bits can be set indicating that some, all, or none of the keys are pressed. The values for Shift are as follows:
0 No key pressed
1 Shift key pressed
2 Ctrl key pressed
3 Shift and Ctrl keys pressed
4 Alt key pressed
5 Shift and Alt keys pressed
6 Ctrl and Atl keys pressed
7 Shift, Ctrl, and Alt keys pressed
X is the X coordinate, in device units, where the mouse button was pressed.
Y is the Y coordinate, in device units, where the mouse button was pressed.
When implementing ITool to create a custom tool, write the code that performs the action when the left mouse button is pressed when this tool is the active tool in the OnMouseDown method.
onMouseDown in interface IToolbutton - The button (in)shift - The shift (in)x - The x (in)y - The y (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void onMouseMove(int button,
int shift,
int x,
int y)
throws IOException,
AutomationException
button specifies which mouse button was pressed while moving the mouse. The button argument is a bit field. Some, all, or none of the bits can be set indicating that some, all, or none of the mouse buttons are pressed. The values for button are as follows:
1 Left button
2 Right button
3 Left and Right buttons
4 Middle button
5 Left and Middle buttons
6 Right and Middle buttons
7 All buttons
Shift indicates whether the Shift key, Ctrl key, or Alt key is pressed when the mouse is moved. The Shift argument is a bit field. Some, all, or none of the bits can be set indicating that some, all, or none of the keys are pressed. The values for Shift are as follows:
0 No key pressed
1 Shift key pressed
2 Ctrl key pressed
3 Shift and Ctrl keys pressed
4 Alt key pressed
5 Shift and Alt keys pressed
6 Ctrl and Atl keys pressed
7 Shift, Ctrl, and Alt keys pressed
X is the X coordinate, in device units, of the mouse location.
Y is the Y coordinate, in device units, of the mouse location.
When implementing ITool to create a custom tool, write the code that performs the action when the mouse is moved when this tool is the active tool in the OnMouseMove method.
onMouseMove in interface IToolbutton - The button (in)shift - The shift (in)x - The x (in)y - The y (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void onMouseUp(int button,
int shift,
int x,
int y)
throws IOException,
AutomationException
button specifies which mouse button is released. The button argument is a bit field. Some, all, or none of the bits can be set indicating that some, all, or none of the mouse buttons are pressed. The values for button are as follows:
1 Left button
2 Right button
3 Left and Right buttons
4 Middle button
5 Left and Middle buttons
6 Right and Middle buttons
7 All buttons
Shift indicates whether the Shift key, Ctrl key, or Alt key is pressed when the mouse button is released. The Shift argument is a bit field. Some, all, or none of the bits can be set indicating that some, all, or none of the keys are pressed. The values for Shift are as follows:
0 No key pressed
1 Shift key pressed
2 Ctrl key pressed
3 Shift and Ctrl keys pressed
4 Alt key pressed
5 Shift and Alt keys pressed
6 Ctrl and Atl keys pressed
7 Shift, Ctrl, and Alt keys pressed
X is the X coordinate, in device units, where the mouse button was released.
Y is the Y coordinate, in device units, where the mouse button was released.
When implementing ITool to create a custom tool, write the code that performs the action when a mouse button is released when this tool is the active tool in the OnMouseUp method.
onMouseUp in interface IToolbutton - The button (in)shift - The shift (in)x - The x (in)y - The y (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void onDblClick()
throws IOException,
AutomationException
When implementing ITool to create a custom tool, write the code that performs the action when a mouse button is double-clicked when this tool is the active tool in the OnDblClick method.
onDblClick in interface IToolIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void onKeyDown(int keyCode,
int shift)
throws IOException,
AutomationException
keyCode specifies which key on the keyboard was pressed.
Shift indicates whether the Shift key, Ctrl key, or Alt key was pressed when the mouse button was pressed. 0 for no keys pressed. 1 for Shift key pressed. 2 for Ctrl key pressed. 4 for Alt key pressed. If both the Shift key and the Ctrl key were pressed, Shift would be 3. If all three keys were pressed, Shift would be 7.
When implementing ITool to create a custom tool, write the code that performs the action when a key on the keyboard is pressed when this tool is the active tool in the OnKeyDown method.
onKeyDown in interface IToolkeyCode - The keyCode (in)shift - The shift (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void onKeyUp(int keyCode,
int shift)
throws IOException,
AutomationException
keyCode specifies which key on the keyboard was released.
Shift indicates whether the Shift key, Ctrl key, or Alt key was pressed when the mouse button was pressed. 0 for no keys pressed. 1 for Shift key pressed. 2 for Ctrl key pressed. 4 for Alt key pressed. If both the Shift key and the Ctrl key were pressed, Shift would be 3. If all three keys were pressed, Shift would be 7.
When implementing ITool to create a custom tool, write the code that performs the action when a key on the keyboard is released when this tool is the active tool in the OnKeyUp method.
onKeyUp in interface IToolkeyCode - The keyCode (in)shift - The shift (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean onContextMenu(int x,
int y)
throws IOException,
AutomationException
X is the X coordinate, in device units, where the right mouse button was pressed.
Y is the Y coordinate, in device units, where the right mouse button was pressed.
When implementing ITool to create a custom tool, write code to display a custom context menu when the right mouse button is pressed when this tool is the active tool in the OnContext method.
If your tool displays a custom context menu, it should let the application know that it handled the OnContextMenu event by returning True from the OnContext function. If you don't do this, the standard context menu will be displayed after your custom context menu.
This method does not fire in ArcGIS Engine. A context menu is implemented using IToolbarMenu in ArcGIS Engine as illustrated by the ControlsEditingSketchContextMenu command.
onContextMenu in interface IToolx - The x (in)y - The y (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void refresh(int hdc)
throws IOException,
AutomationException
hDC is the handle to the display context which just got refreshed in the application.
When implementing ITool to create a custom tool, write the code in the Refresh method that performs some action when a screen display in the application is refreshed while this tool is the active tool. When the current screen display in the application is refreshed, the handle to the device context that is associated with that screen display is passed into the Refresh method as an argument.
refresh in interface IToolhdc - The hdc (A COM typedef) (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean deactivate()
throws IOException,
AutomationException
When implementing ITool to create a custom tool, add some logic to the Deactivate method to specify whether this tool can be deactivated. If ITool_Deactivate is set to False, the default, you cannot interact with any other tools because this tool cannot be interrupted by another tool.
deactivate in interface IToolIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isEnabled()
throws IOException,
AutomationException
When implementing ICommand to create a custom command, add some logic to the Enabled property to specify in what state the application should be in for the command to be enabled.
isEnabled in interface ICommandIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isChecked()
throws IOException,
AutomationException
The Checked property indicates the state of this Command. If a command item appears depressed on a commandbar, the command is checked. The active tool will appear checked. Also commands that serve as a toggle will be checked when that toggle is on.
A system event is periodically called to set the state of the commands on the commandbars indicating which ones are checked.
isChecked in interface ICommandIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getName()
throws IOException,
AutomationException
The Name property of a command is a programmatic identifying name string. By convention, a command's name should include its category name. The format of the Name string should be <Category>_<Caption>. For example, the name of the builtin ArcMap command About ArcMap is "Help_About". Since it is an identifier of the command, the Name property should not be localized.
When implementing ICommand to create a custom command, use the Name property to set the internal name of this command.
Note, the Caption property of a command is the string that appears when the command is placed on a command bar.
public String getName () {return "MyCustomTool_MyTool";}
getName in interface ICommandIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getCaption()
throws IOException,
AutomationException
The Caption property of a command is the string that appears when the command is placed on a command bar.
When implementing ICommand to create a custom command, use the Caption property to set the caption of the command.
public String getCaption() {return "MyTool";}
getCaption in interface ICommandIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getTooltip()
throws IOException,
AutomationException
When implementing ICommand to create a custom command, use the ToolTip property to set the string that appears in the screen tip when the mouse hovers over the command.
public String getTooltip () {return "MyTool";}
getTooltip in interface ICommandIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getMessage()
throws IOException,
AutomationException
When implementing ICommand to create a custom command, use the Message property to set the message string that appears in the statusbar of the application when the mouse passes over the command.
public String getMessage() {return "This is my custom tool";}
getMessage in interface ICommandIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getHelpFile()
throws IOException,
AutomationException
The HelpFile property is used to specify the name of the help file that contains the context sensitive help topic for your custom command.
If you set both the HelpFile and HelpContextID properties, then an end-user of your command can use the "What's This?" command in ArcMap or ArcCatalog to get help on your command. Note, if you want your What's This help to look and behave the same as the standard ArcGIS commands, then you should create a WinHelp file instead of a HTMLHelp file.
If you have a WinHelp file (*.hlp), set ICommand_HelpFile to the name of the help file containing the topic that describes the command and set ICommand_HelpContextID to the topic ID's mapped numeric value. The topic ID is the so-called # footnote in the RTF file you include in your WinHelp file. You can use Help Workshop to add this numeric value by opening the HPJ file, clicking Map and then clicking Add (to add the mapping for an individual topic). See the help topic "To enable a program to display an individual Help topic" in the Help Workshop's help file.
If you have an HTMLHelp file (*.chm) the procedure is similar; specifiy the .chm file as ICommand_HelpFile and the mapped numeric value as ICommand_HelpContextID. Popup topics are problematic with HTMLHelp, but the help topic will display in a default or user-defined window.
As part of your deployment strategy register the name of the WinHelp file (*.hlp) as a new string value in:
HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\Help
Or if you're working with a HTMLHelp file (*.chm) register its name as a new string value in:
HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\HTMLHelp.
Note, if you want to create a custom command that launches your help system, you can call an entire help file and/or use the functionality of the appropriate Help APIs by declaring and using the Windows API WinHelp() function or HTMLHelp() function.
Once you have one of these help functions declared, the OnClick event of your command could call the help function.
getHelpFile in interface ICommandIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.ICommand.getHelpContextID()
public int getHelpContextID()
throws IOException,
AutomationException
The HelpContextID property is used to specify the mapped numeric value of the topic ID of the context sensitive help topic for your custom command. Specify the name of your help file in the HelpFile property.
If you set both the HelpFile and HelpContextID properties, then an end-user of your command can use the "What's This?" command in ArcMap or ArcCatalog to get help on your command. Note, if you want your What's This help to look and behave the same as the standard ArcGIS commands, then you should create a WinHelp file instead of a HTMLHelp file.
If you have a WinHelp file (*.hlp), set ICommand_HelpFile to the name of the help file containing the topic that describes the command and set ICommand_HelpContextID to the topic ID's mapped numeric value. The topic ID is the so-called # footnote in the RTF file you include in your WinHelp file. You can use Help Workshop to add this numeric value by opening the HPJ file, clicking Map and then clicking Add (to add the mapping for an individual topic). See the help topic "To enable a program to display an individual Help topic" in the Help Workshop's help file.
If you have an HTMLHelp file (*.chm) the procedure is similar; specifiy the
.chm file as ICommand_HelpFile and the mapped numeric value as
ICommand_HelpContextID. Popup topics are problematic with HTMLHelp, but the help topic will display in a default or user-defined window.
As part of your deployment strategy register the name of the WinHelp file (*.hlp) as a new string value in:
HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\Help
Or if you're working with a HTMLHelp file (*.chm) register its name as a new string value in:
HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\HTMLHelp.
getHelpContextID in interface ICommandIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.ICommand.getHelpFile()
public int getBitmap()
throws IOException,
AutomationException
When implementing ICommand to create a custom command, use the Bitmap property to set the bitmap to be used as the icon on this command. In your Visual Basic project for this command, the bitmap can be stored in a resource file or in a PictureBox control on a form.
You must use a Bitmap file (.bmp) for the Bitmap property; Icon files (.ico) are not supported. Bitmap files should be 16 X 16 pixels. The color of the upper left pixel of the bitmap is treated as the transparent color. For example, if the upper left pixel of the bitmap is red, then all of the red pixels in the bitmap will be converted to transparent.
When a command is put on a toolbar, the command is displayed with the bitmap only by default; the display type is set to Image Only (ICommandItem::Style = esriCommandStyleIconOnly). When a command is put on a menu, the command is displayed with the bitmap and caption by default; the display type is set to Image and Text (ICommandItem::Style = esriCommandStyleIconAndText). However, if the Bitmap property is not set for this command, then the command will be displayed with the caption only by default when it is put on a toolbar or menu; the display type is set to Text Only (ICommandItem::Style = esriCommandStyleTextOnly).
When implementing ICommand to create a custom command, there is no need to implement this method. In the custom Java Command class, set the bitmapPath String to the physical location of the bitmap file to be used on the toolbar.
bitmapPath = "/images/mybitmap.bmp";
You must use a Bitmap file (.bmp); Icon files (.ico) are not supported. Bitmap files should be 16 X 16 pixels. The color of the upper left pixel of the bitmap is treated as the transparent color. For example, if the upper left pixel of the bitmap is red, then all of the red pixels in the bitmap will be converted to transparent.
When a command is put on a toolbar, the command is displayed with the bitmap only by default; the display type is set to Image Only (esriCommandStyles.esriCommandStyleIconOnly). When a command is put on a menu, the command is displayed with the bitmap and caption by default; the display type is set to Image and Text (esriCommandStyles.esriCommandStyleIconAndText). However, if the Bitmap property is not set for this command, then the command will be displayed with the caption only by default when it is put on a toolbar or menu; the display type is set to Text Only (esriCommandStyles.esriCommandStyleTextOnly).
getBitmap in interface ICommandIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getCategory()
throws IOException,
AutomationException
Category determines where the command will appear in the Commands panel of the Customize dialog.
When implementing ICommand to create a custom command, use the Category property to set the category of this command.
public String getCategory() {return "MyCustomTool";}
getCategory in interface ICommandIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void onCreate(Object hook)
throws IOException,
AutomationException
hook is a reference to an IApplication object or any of the Controls.
The OnCreate method gives the command a hook into the application.
When implementing ICommand to create a custom command, use the OnCreate method to get a hook to the application.
When you implement ICommand to create a custom command, you will find that your class constructor and destructor are called more than once per session. Commands are constructed once initially to get information about them, like the name, bitmap, etc and then they are destroyed. When the final, complete construction takes place, the OnCreate method gets called. OnCreate gets called only once, so you can rely on it to perform initialization of member variables. You can check for initialized member variables in the class destructor to find out if OnCreate has been called previously.
Object buddyControl = null;MapControl mapControl = null;//If your buddy control is of type mapcontrolpublic void onCreate(Object hook) {try {// The hook argument is an instance of control to which this tool is added.// Normally toolbar control.ToolbarControl toolbarControl = new ToolbarControl(hook);//Get the buddy control to which the toolbarcontrol is associated to.buddyControl = toolbarControl.getBuddy();mapControl = new MapControl(buddyControl);}catch (IOException ex) {}}
onCreate in interface ICommandhook - A reference to another Automation Object (IDispatch) (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.IApplication
public void onClick()
throws IOException,
AutomationException
When implementing ICommand to create a custom command, write the code that performs the action when the command is clicked in the OnClick method.
public void onClick() {//In this example, a message is displayed in console.System.out.println("Clicked on my command");}
onClick in interface ICommandIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||