Java Doc for Perspective.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.Perspective

Perspective
public class Perspective (Code)
The ViewManager is a factory for workbench views.


Field Summary
protected  LayoutParteditorArea
    
protected  WorkbenchPagepage
    
protected  PerspectiveHelperpresentation
    

Constructor Summary
public  Perspective(PerspectiveDescriptor desc, WorkbenchPage page)
     ViewManager constructor comment.
protected  Perspective(WorkbenchPage page)
     ViewManager constructor comment.

Method Summary
 voidaddActionSet(IActionSetDescriptor newDesc)
    
public  voidaddFastView(IViewReference ref, boolean handleLayout)
     Sets the fast view attribute.
public  booleanbringToTop(IViewReference ref)
     Moves a part forward in the Z order of a perspective so it is visible.
public  intcalcStackSide(Rectangle stackBounds)
     Determine the correct side to initially dock a new trim part on.
public  booleancontainsView(IViewPart view)
     Returns whether a view exists within the perspective.
 IStatuscreateReferences(IMemento views)
    
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  voiddispose()
     Dispose the perspective and all views contained within.
public  IViewReferencefindView(String viewId)
     Finds the view with the given ID that is open in this page, or null if not found.
public  IViewReferencefindView(String id, String secondaryId)
     Finds the view with the given id and secondary id that is open in this page, or null if not found.
public  IViewReferencegetActiveFastView()
     Return the active fast view or null if there are no fast views or if there are all minimized.
public  IActionSetDescriptor[]getAlwaysOffActionSets()
    
public  IActionSetDescriptor[]getAlwaysOnActionSets()
    
public  CompositegetClientComposite()
     Returns the window's client composite widget which views and editor area will be parented.
public  IPerspectiveDescriptorgetDesc()
     Returns the perspective.
public  booleangetEditorAreaRestoreOnUnzoom()
    
public  intgetEditorAreaState()
    
 RectanglegetFastViewBounds(IViewReference ref)
     Returns the bounds of the given fast view.
public  FastViewManagergetFastViewManager()
    
 FastViewPanegetFastViewPane()
    
public  intgetFastViewState()
    
public  floatgetFastViewWidthRatio(IViewReference ref)
     Retrieves the fast view width ratio for the given view.
public  IViewReference[]getFastViews()
     Returns the docked views.
public  String[]getNewWizardShortcuts()
     Returns the new wizard shortcuts associated with this perspective.
public  IWorkbenchPartReferencegetOldPartRef()
     Returns the old part reference.
public  String[]getPerspectiveShortcuts()
     Returns the perspective shortcuts associated with this perspective.
public  PerspectiveHelpergetPresentation()
     Returns the presentation.
public  ArrayListgetShowInPartIds()
     Returns the ids of the parts to list in the Show In...
public  longgetShowInTime(String partId)
     Returns the time at which the last Show In was performed for the given target part, or 0 if unknown.
public  booleangetShowTitleView(IViewReference ref)
     Returns whether the title for a view should be shown.
public  String[]getShowViewShortcuts()
     Returns the show view shortcuts associated with this perspective.
public  ViewFactorygetViewFactory()
     Returns the view factory.
public  ViewLayoutRecgetViewLayoutRec(IViewReference ref, boolean create)
     Returns the view layout rec for the given view reference, or null if not found.
public  IViewReferencegetViewReference(String viewId, String secondaryId)
     Resolves a view's id into its reference, creating the view if necessary.
Parameters:
  viewId - The primary id of the view (must not benull
Parameters:
  secondaryId - The secondary id of a multiple-instance view(may be null).
public  IViewReference[]getViewReferences()
     See IWorkbenchPage.
protected  voidhideEditorArea()
    
protected  voidhideEditorAreaLocal()
    
 voidhideFastViewSash()
     Hides the fast view sash for zooming in a fast view.
public  booleanhideView(IViewReference ref)
    
public  booleanisCloseable(IViewReference reference)
     Returns whether the given view is closeable in this perspective.
protected  booleanisEditorAreaVisible()
    
public  booleanisFastView(IViewReference ref)
     Returns true if a view is fast.
public  booleanisFixedLayout()
     Returns true if a layout or perspective is fixed.
public  booleanisMoveable(IViewReference reference)
     Returns whether the given view is moveable in this perspective.
public  booleanisStandaloneView(IViewReference ref)
     Returns true if a view is standalone.
public  voidmakeFastView(IViewReference ref)
     Sets the fast view attribute.
protected  voidonActivate()
     activate.
protected  voidonDeactivate()
     deactivate.
public  voidpartActivated(IWorkbenchPart activePart)
     Notifies that a part has been activated.
public  voidperformedShowIn(String partId)
     The user successfully performed a Show In...
public  voidrefreshEditorAreaVisibility()
    
 voidremoveActionSet(String id)
    
 voidremoveActionSet(IActionSetDescriptor toRemove)
    
public  voidremoveFastView(IViewReference ref)
     Sets the fast view attribute.
public  voidremoveFastView(IViewReference ref, boolean handleLayout)
     Sets the fast view attribute.
public  IViewReferencerestoreFastView(IMemento fvMemento, MultiStatus result)
     Restores a fast view to its corrent presentation structure.
public  IStatusrestoreState(IMemento memento)
     Fills a presentation with layout data.
public  IStatusrestoreState()
     Fills a presentation with layout data.
public  voidrestoreTrimPart(LayoutPart part)
    
public  voidrestoreZoomedParts()
    
public  voidsaveDesc()
     Save the layout.
public  voidsaveDescAs(IPerspectiveDescriptor desc)
     Save the layout.
public  IStatussaveState(IMemento memento)
     Save the layout.
 voidsetActiveFastView(IViewReference ref, int steps)
     Sets the active fast view.
 voidsetActiveFastView(IViewReference ref)
     Sets the active fast view.
public  voidsetEditorAreaRestoreOnUnzoom(boolean restore)
    
public  voidsetEditorAreaState(int newState)
    
protected  EditorAreaTrimToolBarsetEditorAreaTrimVisibility(boolean visible)
    
public  voidsetFastViewState(int newState)
    
public  voidsetNewWizardActionIds(ArrayList newList)
     Sets the new wizard actions for the page.
public  voidsetOldPartRef(IWorkbenchPartReference oldPartRef)
     Sets the old part reference.
public  voidsetPerspectiveActionIds(ArrayList list)
     Sets the perspective actions for this page.
public  voidsetShowInPartIds(ArrayList list)
     Sets the ids of the parts to list in the Show In...
public  voidsetShowViewActionIds(ArrayList list)
     Sets the ids of the views to list in the Show View shortcuts.
protected  voidshowEditorArea()
    
protected  voidshowEditorAreaLocal()
    
 booleanshowFastView(IViewReference ref)
     Shows a fast view.
public  IViewPartshowView(String viewId, String secondaryId)
     Shows the view with the given id and secondary id.
public  voidtestInvariants()
     Sanity-checks the LayoutParts in this perspective.
public  voidtoggleFastView(IViewReference ref)
     Toggles the visibility of a fast view.
public  voidturnOffActionSet(IActionSetDescriptor toDisable)
    
public  voidturnOffActionSets(IActionSetDescriptor[] toDisable)
    
public  voidturnOnActionSets(IActionSetDescriptor[] newArray)
    
public static  booleanuseNewMinMax(Perspective activePerspective)
     Used to restrict the use of the new min/max behavior to envoronments in which it has a chance of working...

Field Detail
editorArea
protected LayoutPart editorArea(Code)



page
protected WorkbenchPage page(Code)



presentation
protected PerspectiveHelper presentation(Code)




Constructor Detail
Perspective
public Perspective(PerspectiveDescriptor desc, WorkbenchPage page) throws WorkbenchException(Code)
ViewManager constructor comment.



Perspective
protected Perspective(WorkbenchPage page) throws WorkbenchException(Code)
ViewManager constructor comment.




Method Detail
addActionSet
void addActionSet(IActionSetDescriptor newDesc)(Code)



addFastView
public void addFastView(IViewReference ref, boolean handleLayout)(Code)
Sets the fast view attribute. Note: The page is expected to update action bars.



bringToTop
public boolean bringToTop(IViewReference ref)(Code)
Moves a part forward in the Z order of a perspective so it is visible.
Parameters:
  part - the part to bring to move forward true if the part was brought to top, false if not.



calcStackSide
public int calcStackSide(Rectangle stackBounds)(Code)
Determine the correct side to initially dock a new trim part on. We do this by checking its rect against the editor area.
Parameters:
  stackBounds - The bounds of the stack we want to create trim for the SWT side to dock the trim element on



containsView
public boolean containsView(IViewPart view)(Code)
Returns whether a view exists within the perspective.



createReferences
IStatus createReferences(IMemento views)(Code)



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 -



dispose
public void dispose()(Code)
Dispose the perspective and all views contained within.



findView
public IViewReference findView(String viewId)(Code)
Finds the view with the given ID that is open in this page, or null if not found.
Parameters:
  viewId - the view ID



findView
public IViewReference findView(String id, String secondaryId)(Code)
Finds the view with the given id and secondary id that is open in this page, or null if not found.
Parameters:
  viewId - the view ID
Parameters:
  secondaryId - the secondary ID



getActiveFastView
public IViewReference getActiveFastView()(Code)
Return the active fast view or null if there are no fast views or if there are all minimized.



getAlwaysOffActionSets
public IActionSetDescriptor[] getAlwaysOffActionSets()(Code)



getAlwaysOnActionSets
public IActionSetDescriptor[] getAlwaysOnActionSets()(Code)



getClientComposite
public Composite getClientComposite()(Code)
Returns the window's client composite widget which views and editor area will be parented.



getDesc
public IPerspectiveDescriptor getDesc()(Code)
Returns the perspective.



getEditorAreaRestoreOnUnzoom
public boolean getEditorAreaRestoreOnUnzoom()(Code)
the restore on unzoom state



getEditorAreaState
public int getEditorAreaState()(Code)



getFastViewBounds
Rectangle getFastViewBounds(IViewReference ref)(Code)
Returns the bounds of the given fast view.



getFastViewManager
public FastViewManager getFastViewManager()(Code)
Returns the fastViewManager.



getFastViewPane
FastViewPane getFastViewPane()(Code)



getFastViewState
public int getFastViewState()(Code)



getFastViewWidthRatio
public float getFastViewWidthRatio(IViewReference ref)(Code)
Retrieves the fast view width ratio for the given view. If the ratio is not known, the default ratio for the view is assigned and returned.



getFastViews
public IViewReference[] getFastViews()(Code)
Returns the docked views.



getNewWizardShortcuts
public String[] getNewWizardShortcuts()(Code)
Returns the new wizard shortcuts associated with this perspective. an array of new wizard identifiers



getOldPartRef
public IWorkbenchPartReference getOldPartRef()(Code)
Returns the old part reference. Returns null if there was no previously active part. the old part reference or null



getPerspectiveShortcuts
public String[] getPerspectiveShortcuts()(Code)
Returns the perspective shortcuts associated with this perspective. an array of perspective identifiers



getPresentation
public PerspectiveHelper getPresentation()(Code)
Returns the presentation.



getShowInPartIds
public ArrayList getShowInPartIds()(Code)
Returns the ids of the parts to list in the Show In... dialog. This is a List of Strings.



getShowInTime
public long getShowInTime(String partId)(Code)
Returns the time at which the last Show In was performed for the given target part, or 0 if unknown.



getShowTitleView
public boolean getShowTitleView(IViewReference ref)(Code)
Returns whether the title for a view should be shown. This applies only to standalone views.
since:
   3.0



getShowViewShortcuts
public String[] getShowViewShortcuts()(Code)
Returns the show view shortcuts associated with this perspective. an array of view identifiers



getViewFactory
public ViewFactory getViewFactory()(Code)
Returns the view factory.



getViewLayoutRec
public ViewLayoutRec getViewLayoutRec(IViewReference ref, boolean create)(Code)
Returns the view layout rec for the given view reference, or null if not found. If create is true, it creates the record if not already created.



getViewReference
public IViewReference getViewReference(String viewId, String secondaryId)(Code)
Resolves a view's id into its reference, creating the view if necessary.
Parameters:
  viewId - The primary id of the view (must not benull
Parameters:
  secondaryId - The secondary id of a multiple-instance view(may be null). The reference to the specified view. This may be null if theview fails to create (i.e. thrown a PartInitException)



getViewReferences
public IViewReference[] getViewReferences()(Code)
See IWorkbenchPage.



hideEditorArea
protected void hideEditorArea()(Code)
Hide the editor area if visible



hideEditorAreaLocal
protected void hideEditorAreaLocal()(Code)
Hide the editor area if visible



hideFastViewSash
void hideFastViewSash()(Code)
Hides the fast view sash for zooming in a fast view.



hideView
public boolean hideView(IViewReference ref)(Code)



isCloseable
public boolean isCloseable(IViewReference reference)(Code)
Returns whether the given view is closeable in this perspective.
since:
   3.0



isEditorAreaVisible
protected boolean isEditorAreaVisible()(Code)



isFastView
public boolean isFastView(IViewReference ref)(Code)
Returns true if a view is fast.



isFixedLayout
public boolean isFixedLayout()(Code)
Returns true if a layout or perspective is fixed.



isMoveable
public boolean isMoveable(IViewReference reference)(Code)
Returns whether the given view is moveable in this perspective.
since:
   3.0



isStandaloneView
public boolean isStandaloneView(IViewReference ref)(Code)
Returns true if a view is standalone.
since:
   3.0



makeFastView
public void makeFastView(IViewReference ref)(Code)
Sets the fast view attribute. Note: The page is expected to update action bars.



onActivate
protected void onActivate()(Code)
activate.



onDeactivate
protected void onDeactivate()(Code)
deactivate.



partActivated
public void partActivated(IWorkbenchPart activePart)(Code)
Notifies that a part has been activated.



performedShowIn
public void performedShowIn(String partId)(Code)
The user successfully performed a Show In... action on the specified part. Update the history.



refreshEditorAreaVisibility
public void refreshEditorAreaVisibility()(Code)



removeActionSet
void removeActionSet(String id)(Code)



removeActionSet
void removeActionSet(IActionSetDescriptor toRemove)(Code)



removeFastView
public void removeFastView(IViewReference ref)(Code)
Sets the fast view attribute. Note: The page is expected to update action bars.



removeFastView
public void removeFastView(IViewReference ref, boolean handleLayout)(Code)
Sets the fast view attribute. Note: The page is expected to update action bars.



restoreFastView
public IViewReference restoreFastView(IMemento fvMemento, MultiStatus result)(Code)
Restores a fast view to its corrent presentation structure. This method is pubilc because the FastViewManager uses it to reconstruct it minimized stacks on startup.
Parameters:
  fvMemento - The mement containing the fast view info
Parameters:
  result - The result status The reference to the restored view



restoreState
public IStatus restoreState(IMemento memento)(Code)
Fills a presentation with layout data. Note: This method should not modify the current state of the perspective.



restoreState
public IStatus restoreState()(Code)
Fills a presentation with layout data. Note: This method should not modify the current state of the perspective.



restoreTrimPart
public void restoreTrimPart(LayoutPart part)(Code)
Restores a part in the trim to the actual layout
Parameters:
  part - The part to restore



restoreZoomedParts
public void restoreZoomedParts()(Code)
Restore any parts that are showing in the trim as a result of a 'zoom' operation



saveDesc
public void saveDesc()(Code)
Save the layout.



saveDescAs
public void saveDescAs(IPerspectiveDescriptor desc)(Code)
Save the layout.



saveState
public IStatus saveState(IMemento memento)(Code)
Save the layout.



setActiveFastView
void setActiveFastView(IViewReference ref, int steps)(Code)
Sets the active fast view. If a different fast view is already open, it shrinks equally steps times before disappearing completely. Then, view becomes active and is shown.



setActiveFastView
void setActiveFastView(IViewReference ref)(Code)
Sets the active fast view.



setEditorAreaRestoreOnUnzoom
public void setEditorAreaRestoreOnUnzoom(boolean restore)(Code)
Sets the restore on unzoom state for the editor area
Parameters:
  restore - the new state



setEditorAreaState
public void setEditorAreaState(int newState)(Code)



setEditorAreaTrimVisibility
protected EditorAreaTrimToolBar setEditorAreaTrimVisibility(boolean visible)(Code)



setFastViewState
public void setFastViewState(int newState)(Code)



setNewWizardActionIds
public void setNewWizardActionIds(ArrayList newList)(Code)
Sets the new wizard actions for the page. This is List of Strings.



setOldPartRef
public void setOldPartRef(IWorkbenchPartReference oldPartRef)(Code)
Sets the old part reference.
Parameters:
  oldPartRef - The old part reference to set, or null



setPerspectiveActionIds
public void setPerspectiveActionIds(ArrayList list)(Code)
Sets the perspective actions for this page. This is List of Strings.



setShowInPartIds
public void setShowInPartIds(ArrayList list)(Code)
Sets the ids of the parts to list in the Show In... prompter. This is a List of Strings.



setShowViewActionIds
public void setShowViewActionIds(ArrayList list)(Code)
Sets the ids of the views to list in the Show View shortcuts. This is a List of Strings.



showEditorArea
protected void showEditorArea()(Code)
Show the editor area if not visible



showEditorAreaLocal
protected void showEditorAreaLocal()(Code)
Show the editor area if not visible



showFastView
boolean showFastView(IViewReference ref)(Code)
Shows a fast view. whether the view was successfully shown



showView
public IViewPart showView(String viewId, String secondaryId) throws PartInitException(Code)
Shows the view with the given id and secondary id.



testInvariants
public void testInvariants()(Code)
Sanity-checks the LayoutParts in this perspective. Throws an Assertation exception if an object's internal state is invalid.



toggleFastView
public void toggleFastView(IViewReference ref)(Code)
Toggles the visibility of a fast view. If the view is active it is deactivated. Otherwise, it is activated.



turnOffActionSet
public void turnOffActionSet(IActionSetDescriptor toDisable)(Code)



turnOffActionSets
public void turnOffActionSets(IActionSetDescriptor[] toDisable)(Code)



turnOnActionSets
public void turnOnActionSets(IActionSetDescriptor[] newArray)(Code)



useNewMinMax
public static boolean useNewMinMax(Perspective activePerspective)(Code)
Used to restrict the use of the new min/max behavior to envoronments in which it has a chance of working...
Parameters:
  activePerspective - We pass this in as an arg so others won't haveto check it for 'null' (which is one of the failure cases)



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.