Java Doc for ModalTool.java in  » GIS » udig-1.1 » net » refractions » udig » project » ui » tool » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » GIS » udig 1.1 » net.refractions.udig.project.ui.tool 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


net.refractions.udig.project.ui.tool.ModalTool

All known Subclasses:   net.refractions.udig.tools.internal.Pan,  net.refractions.udig.tools.edit.impl.DeleteTool,  net.refractions.udig.tool.select.BBoxSelection,  net.refractions.udig.project.ui.tool.AbstractModalTool,  net.refractions.udig.tool.info.InfoTool,  net.refractions.udig.project.ui.internal.tool.display.ToolProxy,  net.refractions.udig.tools.internal.Zoom,  net.refractions.udig.tool.select.ArrowSelection,
ModalTool
public interface ModalTool extends Tool(Code)
A ModalTool is a tool which "takes control" of operation. An example is the zoom tool. If the zoom tool is "on" then other tools modal tools must be off.

Must have a public default constructor so that the plugin frame work can instantiate the class.

Contains the following properties:
  • ToolConstants.DEFAULT_CURSOR_ID_KEY - the cursor ID value from "toolCursorId" attribute of "modalTool" extension


See Also:   net.refractions.udig.project.ui.tool.AbstractModalTool
author:
   Jesse Eichar
version:
   $Revision: 1.9 $



Field Summary
final public static  StringCROSSHAIR_CURSOR
     The crosshair cursor type.
final public static  StringDEFAULT_CURSOR
     The default cursor type (gets set if no cursor is defined).
final public static  StringE_RESIZE_CURSOR
     The east-resize cursor type.
final public static  StringHAND_CURSOR
     The hand cursor type.
final public static  StringMOVE_CURSOR
     The move cursor type.
final public static  StringNE_RESIZE_CURSOR
     The north-east-resize cursor type.
final public static  StringNO_CURSOR
    
final public static  StringNW_RESIZE_CURSOR
     The north-west-resize cursor type.
final public static  StringN_RESIZE_CURSOR
     The north-resize cursor type.
final public static  StringSE_RESIZE_CURSOR
     The south-east-resize cursor type.
final public static  StringSW_RESIZE_CURSOR
     The south-west-resize cursor type.
final public static  StringS_RESIZE_CURSOR
     The south-resize cursor type.
final public static  StringTEXT_CURSOR
     The text cursor type.
final public static  StringWAIT_CURSOR
     The wait cursor type.
final public static  StringW_RESIZE_CURSOR
     The west-resize cursor type.


Method Summary
public  StringgetCursorID()
     Returns current cursor ID of the modal tool.
public  IMapEditorSelectionProvidergetSelectionProvider()
     Returns tool's selection provider.

Now the modal tool may have 0..1 of selection providers.

public  booleanisActive()
     Returns true if the current tool is active.
public  voidsetActive(boolean active)
     Called when tool button is pressed.
public  voidsetCursorID(String id)
     Sets the current cursor ID for the modal tool.
public  voidsetSelectionProvider(IMapEditorSelectionProvider selectionProvider)
     Sets tool's selection provider.

Field Detail
CROSSHAIR_CURSOR
final public static String CROSSHAIR_CURSOR(Code)
The crosshair cursor type.



DEFAULT_CURSOR
final public static String DEFAULT_CURSOR(Code)
The default cursor type (gets set if no cursor is defined).



E_RESIZE_CURSOR
final public static String E_RESIZE_CURSOR(Code)
The east-resize cursor type.



HAND_CURSOR
final public static String HAND_CURSOR(Code)
The hand cursor type.



MOVE_CURSOR
final public static String MOVE_CURSOR(Code)
The move cursor type.



NE_RESIZE_CURSOR
final public static String NE_RESIZE_CURSOR(Code)
The north-east-resize cursor type.



NO_CURSOR
final public static String NO_CURSOR(Code)



NW_RESIZE_CURSOR
final public static String NW_RESIZE_CURSOR(Code)
The north-west-resize cursor type.



N_RESIZE_CURSOR
final public static String N_RESIZE_CURSOR(Code)
The north-resize cursor type.



SE_RESIZE_CURSOR
final public static String SE_RESIZE_CURSOR(Code)
The south-east-resize cursor type.



SW_RESIZE_CURSOR
final public static String SW_RESIZE_CURSOR(Code)
The south-west-resize cursor type.



S_RESIZE_CURSOR
final public static String S_RESIZE_CURSOR(Code)
The south-resize cursor type.



TEXT_CURSOR
final public static String TEXT_CURSOR(Code)
The text cursor type.



WAIT_CURSOR
final public static String WAIT_CURSOR(Code)
The wait cursor type.



W_RESIZE_CURSOR
final public static String W_RESIZE_CURSOR(Code)
The west-resize cursor type.





Method Detail
getCursorID
public String getCursorID()(Code)
Returns current cursor ID of the modal tool.



getSelectionProvider
public IMapEditorSelectionProvider getSelectionProvider()(Code)
Returns tool's selection provider.

Now the modal tool may have 0..1 of selection providers. the modal tool's selection provider.




isActive
public boolean isActive()(Code)
Returns true if the current tool is active.



setActive
public void setActive(boolean active)(Code)
Called when tool button is pressed. If active is set to true the tool is Registered with the source Component so that it receives events and will begin operating If active is set to false the tool is set as inactive and deregistered with the component.
Parameters:
  active - if true the tool is Registered with the source Component so that it receivesevents and will begin operating. if false the tool is set as inactive and deregisteredwith the component.



setCursorID
public void setCursorID(String id)(Code)
Sets the current cursor ID for the modal tool. If it is needed the actual updating of the mouse cursor is performed automatically.
Parameters:
  id - the cursor ID from net.refractions.udig.project.ui.tool.toolCursorextension or the constant from ModalTool interface.



setSelectionProvider
public void setSelectionProvider(IMapEditorSelectionProvider selectionProvider)(Code)
Sets tool's selection provider.

Usually it is configured through extension point.
Parameters:
  selectionProvider -




www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.