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


java.lang.Object
   org.eclipse.ui.internal.PerspectiveHelper

PerspectiveHelper
public class PerspectiveHelper (Code)
A perspective presentation is a collection of parts with a layout. Each part is parented to a main window, so you can create more than one presentation on a set of parts and change the layout just by activating / deactivating a presentation. In addition, the user can change the position of any part by mouse manipulation (drag & drop). If a part is removed, we leave a placeholder behind to indicate where it goes should the part be added back.


Field Summary
protected  ActualDropTargetdropTarget
    

Constructor Summary
public  PerspectiveHelper(WorkbenchPage workbenchPage, ViewSashContainer mainLayout, Perspective perspective)
     Constructs a new object.

Method Summary
public  voidactivate(Composite parent)
     Show the presentation.
public  voidaddDetachedPart(LayoutPart part)
     Create a detached window containing a part.
public  voidaddDetachedPart(LayoutPart part, Rectangle bounds)
    
public  voidaddPart(LayoutPart part)
     Adds a part to the presentation.
public  voidattachPart(IViewReference ref)
     Attaches a part that was previously detached to the mainLayout.
public  booleanbringPartToTop(LayoutPart part)
     Bring a part forward so it is visible.
public  booleancanDetach()
     Return whether detachable parts can be supported.
public  voidcollectViewPanes(List result)
     Answer a list of the view panes.
public  voiddeactivate()
     Hide the presentation.
 voidderefPart(LayoutPart part)
     Deref a given part.
public  voiddescribeLayout(StringBuffer buf)
     Writes a description of the layout to the given string buffer. This is used for drag-drop test suites to determine if two layouts are the same.
public  voiddetachPart(IViewReference ref)
     Detached a part from the mainLayout.
public  voiddispose()
    
public  LayoutPartfindPart(String primaryId, String secondaryId)
     Find the first part that matches the specified primary and secondary id pair.
public  voidforceNoZoom()
     Forces the perspective to have no zoomed or minimized parts.
public  RectanglegetCachedBoundsFor(String id)
    
public static  floatgetDockingRatio(LayoutPart source, LayoutPart target)
    
public  ViewSashContainergetLayout()
     Returns the layout container.
public  PartStackgetMaximizedStack()
    
public  booleanhasPlaceholder(String id)
     Returns true if a placeholder exists for a given ID.
public  booleanhasPlaceholder(String primaryId, String secondaryId)
     Returns true if a placeholder exists for a given ID.
public  booleanisActive()
     Gets the active state.
public  booleanisPartVisible(IWorkbenchPartReference partRef)
     Returns true if the given part is visible.
public  booleanisZoomed()
     Returns whether the presentation is zoomed. NOTE: As of 3.3 this method should always return 'false' when using the new min/max behavior.
public  booleanpartChangeAffectsZoom(LayoutPart pane)
     Returns whether changes to a part will affect zoom.
public  voidremovePart(LayoutPart part)
     Remove all references to a part.
public  voidreplacePlaceholderWithPart(LayoutPart part)
     Add a part to the presentation. Note: unlike all other LayoutParts, PartPlaceholders will still point to their parent container even when it is inactive.
public  voidresetBoundsMap()
    
public  IStatusrestoreState(IMemento memento)
    
public  IStatussaveState(IMemento memento)
    
public  voidsetMaximizedStack(PartStack stack)
     Sets the currently maximized stack.
public  voidupdateBoundsMap()
     Captures the current bounds of all ViewStacks and the editor area and puts them into an ID -> Rectangle map.
public  booleanwillPartBeVisible(String partId)
     Returns true is not in a tab folder or if it is the top one in a tab folder.
public  booleanwillPartBeVisible(String partId, String secondaryId)
    
public  voidzoomIn(IWorkbenchPartReference ref)
     Zoom in on a particular layout part.
public  voidzoomOut()
     Zoom out.

Field Detail
dropTarget
protected ActualDropTarget dropTarget(Code)




Constructor Detail
PerspectiveHelper
public PerspectiveHelper(WorkbenchPage workbenchPage, ViewSashContainer mainLayout, Perspective perspective)(Code)
Constructs a new object.




Method Detail
activate
public void activate(Composite parent)(Code)
Show the presentation.



addDetachedPart
public void addDetachedPart(LayoutPart part)(Code)
Create a detached window containing a part.



addDetachedPart
public void addDetachedPart(LayoutPart part, Rectangle bounds)(Code)



addPart
public void addPart(LayoutPart part)(Code)
Adds a part to the presentation. If a placeholder exists for the part then swap the part in. Otherwise, add the part in the bottom right corner of the presentation.



attachPart
public void attachPart(IViewReference ref)(Code)
Attaches a part that was previously detached to the mainLayout.
Parameters:
  ref -



bringPartToTop
public boolean bringPartToTop(LayoutPart part)(Code)
Bring a part forward so it is visible. true if the part was brought to top, false if not.



canDetach
public boolean canDetach()(Code)
Return whether detachable parts can be supported.



collectViewPanes
public void collectViewPanes(List result)(Code)
Answer a list of the view panes.



deactivate
public void deactivate()(Code)
Hide the presentation.



derefPart
void derefPart(LayoutPart part)(Code)
Deref a given part. Deconstruct its container as required. Do not remove drag listeners.



describeLayout
public void describeLayout(StringBuffer buf)(Code)
Writes a description of the layout to the given string buffer. This is used for drag-drop test suites to determine if two layouts are the same. Like a hash code, the description should compare as equal iff the layouts are the same. However, it should be user-readable in order to help debug failed tests. Although these are english readable strings, they should not be translated or equality tests will fail.

This is only intended for use by test suites.


Parameters:
  buf -



detachPart
public void detachPart(IViewReference ref)(Code)
Detached a part from the mainLayout. Presently this does not use placeholders since the current implementation is not robust enough to remember a view's position in more than one root container. For now the view is simply derefed and will dock in the default position when attachPart is called. By default parts detached this way are set to float on top of the workbench without docking. It is assumed that people that want to drag a part back onto the WorkbenchWindow will detach it via drag and drop.
Parameters:
  ref -



dispose
public void dispose()(Code)



findPart
public LayoutPart findPart(String primaryId, String secondaryId)(Code)
Find the first part that matches the specified primary and secondary id pair. Wild cards are supported.



forceNoZoom
public void forceNoZoom()(Code)
Forces the perspective to have no zoomed or minimized parts. This is used when switching to the 3.3 presentation...



getCachedBoundsFor
public Rectangle getCachedBoundsFor(String id)(Code)



getDockingRatio
public static float getDockingRatio(LayoutPart source, LayoutPart target)(Code)
Returns the ratio that should be used when docking the given source part onto the given target
Parameters:
  source - newly added part
Parameters:
  target - existing part being dragged over the final size of the source part (wrt the current size of target)after it is docked



getLayout
public ViewSashContainer getLayout()(Code)
Returns the layout container.



getMaximizedStack
public PartStack getMaximizedStack()(Code)
The currently maxmized stack (if any)



hasPlaceholder
public boolean hasPlaceholder(String id)(Code)
Returns true if a placeholder exists for a given ID.



hasPlaceholder
public boolean hasPlaceholder(String primaryId, String secondaryId)(Code)
Returns true if a placeholder exists for a given ID.
since:
   3.0



isActive
public boolean isActive()(Code)
Gets the active state.



isPartVisible
public boolean isPartVisible(IWorkbenchPartReference partRef)(Code)
Returns true if the given part is visible. A part is visible if it's top-level (not in a tab folder) or if it is the top one in a tab folder.



isZoomed
public boolean isZoomed()(Code)
Returns whether the presentation is zoomed. NOTE: As of 3.3 this method should always return 'false' when using the new min/max behavior. It is only used for legacy 'zoom' handling.



partChangeAffectsZoom
public boolean partChangeAffectsZoom(LayoutPart pane)(Code)
Returns whether changes to a part will affect zoom. There are a few conditions for this .. - we are zoomed. - the part is contained in the main window. - the part is not the zoom part - the part is not a fast view - the part and the zoom part are not in the same editor workbook - the part and the zoom part are not in the same view stack.



removePart
public void removePart(LayoutPart part)(Code)
Remove all references to a part.



replacePlaceholderWithPart
public void replacePlaceholderWithPart(LayoutPart part)(Code)
Add a part to the presentation. Note: unlike all other LayoutParts, PartPlaceholders will still point to their parent container even when it is inactive. This method relies on this fact to locate the parent.



resetBoundsMap
public void resetBoundsMap()(Code)
Resets the bounds map so that it won't interfere with normal minimize operayions



restoreState
public IStatus restoreState(IMemento memento)(Code)

See Also:   org.eclipse.ui.IPersistable



saveState
public IStatus saveState(IMemento memento)(Code)

See Also:   org.eclipse.ui.IPersistable



setMaximizedStack
public void setMaximizedStack(PartStack stack)(Code)
Sets the currently maximized stack. Used for query and 'unZoom' purposes in the 3.3 presentation.
Parameters:
  stack - The newly maximized stack



updateBoundsMap
public void updateBoundsMap()(Code)
Captures the current bounds of all ViewStacks and the editor area and puts them into an ID -> Rectangle map. This info is used to cache the bounds so that we can correctly place minimized stacks during a 'maximized' operation (where the iterative min's affect the current layout while being performed.



willPartBeVisible
public boolean willPartBeVisible(String partId)(Code)
Returns true is not in a tab folder or if it is the top one in a tab folder.



willPartBeVisible
public boolean willPartBeVisible(String partId, String secondaryId)(Code)



zoomIn
public void zoomIn(IWorkbenchPartReference ref)(Code)
Zoom in on a particular layout part.



zoomOut
public void zoomOut()(Code)
Zoom out.



Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

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