Java Doc for IIntroPart.java in  » IDE-Eclipse » ui-workbench » org » eclipse » ui » intro » 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 » IDE Eclipse » ui workbench » org.eclipse.ui.intro 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


org.eclipse.ui.intro.IIntroPart

All known Subclasses:   org.eclipse.ui.part.IntroPart,
IIntroPart
public interface IIntroPart extends IAdaptable(Code)
The intro part is a visual component within the workbench responsible for introducing the product to new users. The intro part is typically shown the first time a product is started up.

The intro part implementation is contributed to the workbench via the org.eclipse.ui.intro extension point. There can be several intro part implementations, and associations between intro part implementations and products. The workbench will only make use of the intro part implementation for the current product (as given by org.eclipse.core.runtime.Platform.getProduct . There is at most one intro part instance in the entire workbench, and it resides in exactly one workbench window at a time.

This interface in not intended to be directly implemented. Rather, clients providing a intro part implementation should subclass org.eclipse.ui.part.IntroPart .


See Also:   org.eclipse.ui.intro.IIntroManager.showIntro(org.eclipse.ui.IWorkbenchWindowboolean)
since:
   3.0


Field Summary
final public static  intPROP_TITLE
     The property id for getTitleImage and getTitle.


Method Summary
public  voidaddPropertyListener(IPropertyListener listener)
     Adds a listener for changes to properties of this intro part.
public  voidcreatePartControl(Composite parent)
     Creates the SWT controls for this intro part.

Clients should not call this method (the workbench calls this method when it needs to, which may be never).

For implementors this is a multi-step process:

  1. Create one or more controls within the parent.
  2. Set the parent layout as needed.
  3. Register any global actions with the IActionService.
  4. Register any popup menus with the IActionService.
  5. Register a selection provider with the ISelectionService (optional).
public  voiddispose()
     Disposes of this intro part.

This is the last method called on the IIntroPart.

 IIntroSitegetIntroSite()
     Returns the site for this intro part.
public  StringgetTitle()
     Returns the title of this intro part.
public  ImagegetTitleImage()
     Returns the title image of this intro part.
public  voidinit(IIntroSite site, IMemento memento)
     Initializes this intro part with the given intro site.
public  voidremovePropertyListener(IPropertyListener listener)
     Removes the given property listener from this intro part.
public  voidsaveState(IMemento memento)
     Saves the object state within a memento.

This method is automatically called by the workbench at appropriate times.

public  voidsetFocus()
     Asks this part to take focus within the workbench.

Clients should not call this method (the workbench calls this method at appropriate times).

public  voidstandbyStateChanged(boolean standby)
     Sets the standby state of this intro part.

Field Detail
PROP_TITLE
final public static int PROP_TITLE(Code)
The property id for getTitleImage and getTitle.
since:
   3.2 this property now covers changes to getTitle in
since:
   addition to getTitleImage





Method Detail
addPropertyListener
public void addPropertyListener(IPropertyListener listener)(Code)
Adds a listener for changes to properties of this intro part. Has no effect if an identical listener is already registered.

The properties ids are as follows:

  • IIntroPart.PROP_TITLE


Parameters:
  listener - a property listener



createPartControl
public void createPartControl(Composite parent)(Code)
Creates the SWT controls for this intro part.

Clients should not call this method (the workbench calls this method when it needs to, which may be never).

For implementors this is a multi-step process:

  1. Create one or more controls within the parent.
  2. Set the parent layout as needed.
  3. Register any global actions with the IActionService.
  4. Register any popup menus with the IActionService.
  5. Register a selection provider with the ISelectionService (optional).


Parameters:
  parent - the parent control



dispose
public void dispose()(Code)
Disposes of this intro part.

This is the last method called on the IIntroPart. At this point the part controls (if they were ever created) have been disposed as part of an SWT composite. There is no guarantee that createPartControl() has been called, so the part controls may never have been created.

Within this method a part may release any resources, fonts, images, etc.  held by this part. It is also very important to deregister all listeners from the workbench.

Clients should not call this method (the workbench calls this method at appropriate times).




getIntroSite
IIntroSite getIntroSite()(Code)
Returns the site for this intro part. the intro site



getTitle
public String getTitle()(Code)
Returns the title of this intro part. If this value changes the part must fire a property listener event with IIntroPart.PROP_TITLE .

The title is used to populate the title bar of this part's visual container.

the intro part title (not null)
since:
   3.2



getTitleImage
public Image getTitleImage()(Code)
Returns the title image of this intro part. If this value changes the part must fire a property listener event with IIntroPart.PROP_TITLE .

The title image is usually used to populate the title bar of this part's visual container. Since this image is managed by the part itself, callers must not dispose the returned image.

the title image



init
public void init(IIntroSite site, IMemento memento) throws PartInitException(Code)
Initializes this intro part with the given intro site. A memento is passed to the part which contains a snapshot of the part state from a previous session. Where possible, the part should try to recreate that state.

This method is automatically called by the workbench shortly after part construction. It marks the start of the intro's lifecycle. Clients must not call this method.


Parameters:
  site - the intro site
Parameters:
  memento - the intro part state or null if there is no previoussaved state
exception:
  PartInitException - if this part was not initializedsuccessfully



removePropertyListener
public void removePropertyListener(IPropertyListener listener)(Code)
Removes the given property listener from this intro part. Has no affect if an identical listener is not registered.
Parameters:
  listener - a property listener



saveState
public void saveState(IMemento memento)(Code)
Saves the object state within a memento.

This method is automatically called by the workbench at appropriate times. Clients must not call this method directly.


Parameters:
  memento - a memento to receive the object state



setFocus
public void setFocus()(Code)
Asks this part to take focus within the workbench.

Clients should not call this method (the workbench calls this method at appropriate times). To have the workbench activate a part, use IIntroManager.showIntro(IWorkbenchWindowboolean) .




standbyStateChanged
public void standbyStateChanged(boolean standby)(Code)
Sets the standby state of this intro part. An intro part should render itself differently in the full and standby modes. In standby mode, the part should be partially visible to the user but otherwise allow them to work. In full mode, the part should be fully visible and be the center of the user's attention.

This method is automatically called by the workbench at appropriate times. Clients must not call this method directly (call IIntroManager.setIntroStandby(IIntroPartboolean) instead.


Parameters:
  standby - true to put this part in its partiallyvisible standy mode, and false to make it fully visible



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