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

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL 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 .LayoutPart

All known Subclasses:   org.eclipse.ui.internal .LayoutPartSash,  org.eclipse.ui.internal .PartPlaceholder,  org.eclipse.ui.internal .PartSashContainer,  org.eclipse.ui.internal .PartPane,  org.eclipse.ui.internal .PartStack,
LayoutPart
abstract public class LayoutPart implements ISizeProvider(Code)
A presentation part is used to build the presentation for the workbench. Common subclasses are pane and folder.

Field Summary
final public static String PROP_VISIBILITY

protected ILayoutContainer container

protected String id


Constructor Summary
public LayoutPart(String id)
     PresentationPart constructor comment.

Method Summary
public boolean allowsAdd(LayoutPart toAdd)

public boolean allowsAutoFocus()
     When a layout part closes, focus will return to a previously active part. This method determines whether this part should be considered for activation when another part closes.
public boolean childIsZoomed(LayoutPart childToTest)

public boolean childObscuredByZoom(LayoutPart toTest)

public void childRequestZoomIn(LayoutPart toZoom)

public void childRequestZoomOut()

public int computePreferredSize(boolean width, int availableParallel, int availablePerpendicular, int preferredParallel)

abstract public void createControl(Composite parent)

final public void deferUpdates(boolean shouldDefer)
     deferUpdates(true) disables widget updates until a corresponding call to deferUpdates(false).
public void describeLayout(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 void dispose()

public void flushLayout()

public Rectangle getBounds()
     Gets the presentation bounds.
public String getCompoundId()
     Returns the compound ID for this part.
public ILayoutContainer getContainer()
     Gets the parent for this part.
In general, this is non-null if the object has been added to a container and the container's widgetry exists.
abstract public Control getControl()
     Get the part control.
public IDropTarget getDropTarget(Object draggedObject, Point displayCoordinates)

public String getID()
     Gets the ID for this part.
public LayoutPart getPart()

public String getPlaceHolderId()
     Returns an id representing this part, suitable for use in a placeholder.
public Shell getShell()

public Point getSize()
     Gets the presentation size.
public int getSizeFlags(boolean horizontal)

public boolean getVisible()
     Returns true if this part was set visible.
public IWorkbenchWindow getWorkbenchWindow()
     Returns the workbench window window for a part.
protected void handleDeferredEvents()
     Immediately processes all UI events which were deferred due to a call to deferUpdates(true).
public boolean isCompressible()

final protected boolean isDeferred()
     Subclasses can call this method to determine whether UI updates should be deferred.
public boolean isDocked()

final public boolean isObscuredByZoom()

public boolean isVisible()
     Returns true if this part can be seen.
public void moveAbove(Control refControl)
     Move the control over another one.
public void reparent(Composite newParent)
     Reparent a part.
final public void requestZoomIn()

final public void requestZoomOut()

public void resizeChild(LayoutPart childThatChanged)

public void setBounds(Rectangle r)
     Sets the presentation bounds.
public void setContainer(ILayoutContainer container)
     Sets the parent for this part.
public void setFocus()
     Sets focus to this part.
public void setID(String str)
     Sets the part ID.
public void setVisible(boolean makeVisible)
     Shows the receiver if visible is true otherwise hide it.
public void setZoomed(boolean isZoomed)

protected void startDeferringEvents()
     This is called when deferUpdates(true) causes UI events for this part to be deferred.
public void testInvariants()
     Tests the integrity of this object.

Field Detail
PROP_VISIBILITY
final public static String PROP_VISIBILITY(Code)

container
protected ILayoutContainer container(Code)

id
protected String id(Code)

Constructor Detail
LayoutPart
public LayoutPart(String id)(Code)
PresentationPart constructor comment.

Method Detail
allowsAdd
public boolean allowsAdd(LayoutPart toAdd)(Code)
Returns true iff the given part can be added to this ILayoutContainer
Parameters:
  toAdd -
since:
   3.1

allowsAutoFocus
public boolean allowsAutoFocus()(Code)
When a layout part closes, focus will return to a previously active part. This method determines whether this part should be considered for activation when another part closes. If a group of parts are all closing at the same time, they will all return false from this method while closing to ensure that the parent does not activate a part that is in the process of closing. Parts will also return false from this method if they are minimized, closed fast views, obscured by zoom, etc. true iff the parts in this container may be given focus when the activepart is closed

childIsZoomed
public boolean childIsZoomed(LayoutPart childToTest)(Code)

childObscuredByZoom
public boolean childObscuredByZoom(LayoutPart toTest)(Code)

childRequestZoomIn
public void childRequestZoomIn(LayoutPart toZoom)(Code)

childRequestZoomOut
public void childRequestZoomOut()(Code)

computePreferredSize
public int computePreferredSize(boolean width, int availableParallel, int availablePerpendicular, int preferredParallel)(Code)

See Also:   org.eclipse.ui.presentations.StackPresentation.computePreferredSize(booleanintintint)
since:
   3.1

createControl
abstract public void createControl(Composite parent)(Code)
Creates the SWT control

deferUpdates
final public void deferUpdates(boolean shouldDefer)(Code)
deferUpdates(true) disables widget updates until a corresponding call to deferUpdates(false). Exactly what gets deferred is the decision of each LayoutPart, however the part may only defer operations in a manner that does not affect the final result. That is, the state of the receiver after the final call to deferUpdates(false) must be exactly the same as it would have been if nothing had been deferred.
Parameters:
  shouldDefer - true iff events should be deferred

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 do not need to be translated.
Parameters:
  buf -

dispose
public void dispose()(Code)
Disposes the SWT control

flushLayout
public void flushLayout()(Code)

getBounds
public Rectangle getBounds()(Code)
Gets the presentation bounds.

getCompoundId
public String getCompoundId()(Code)
Returns the compound ID for this part. The compound ID is of the form: primaryId [':' + secondaryId] the compound ID for this part.

getContainer
public ILayoutContainer getContainer()(Code)
Gets the parent for this part.
In general, this is non-null if the object has been added to a container and the container's widgetry exists. The exception to this rule is PartPlaceholders created when restoring a ViewStack using restoreState, which point to the ViewStack even if its widgetry doesn't exist yet. Returns null in the remaining cases.

TODO: change the semantics of this method to always point to the parent container, regardless of whether its widgetry exists. Locate and refactor code that is currently depending on the special cases.

getControl
abstract public Control getControl()(Code)
Get the part control. This method may return null.

getDropTarget
public IDropTarget getDropTarget(Object draggedObject, Point displayCoordinates)(Code)

getID
public String getID()(Code)
Gets the ID for this part.

getPart
public LayoutPart getPart()(Code)

getPlaceHolderId
public String getPlaceHolderId()(Code)
Returns an id representing this part, suitable for use in a placeholder.
since:
   3.0

getShell
public Shell getShell()(Code)

getSize
public Point getSize()(Code)
Gets the presentation size.

getSizeFlags
public int getSizeFlags(boolean horizontal)(Code)

See Also:   org.eclipse.ui.presentations.StackPresentation.getSizeFlags(boolean)
since:
   3.1

getVisible
public boolean getVisible()(Code)
Returns true if this part was set visible. This returns whatever was last passed into setVisible, but does not necessarily indicate that the part can be seen (ie: one of its ancestors may be invisible)

getWorkbenchWindow
public IWorkbenchWindow getWorkbenchWindow()(Code)
Returns the workbench window window for a part. the workbench window, or null if there's no windowassociated with this part.

handleDeferredEvents
protected void handleDeferredEvents()(Code)
Immediately processes all UI events which were deferred due to a call to deferUpdates(true). This is called when the last call is made to deferUpdates(false). Subclasses should overload this method if they defer some or all UI processing during deferUpdates.

isCompressible
public boolean isCompressible()(Code)

isDeferred
final protected boolean isDeferred()(Code)
Subclasses can call this method to determine whether UI updates should be deferred. Returns true iff there have been any calls to deferUpdates(true) without a corresponding call to deferUpdates(false). Any operation which is deferred based on the result of this method should be performed later within handleDeferredEvents(). true iff updates should be deferred.

isDocked
public boolean isDocked()(Code)

isObscuredByZoom
final public boolean isObscuredByZoom()(Code)

isVisible
public boolean isVisible()(Code)
Returns true if this part can be seen. Returns false if the part or any of its ancestors are invisible.

moveAbove
public void moveAbove(Control refControl)(Code)
Move the control over another one.

reparent
public void reparent(Composite newParent)(Code)
Reparent a part.

requestZoomIn
final public void requestZoomIn()(Code)

requestZoomOut
final public void requestZoomOut()(Code)

resizeChild
public void resizeChild(LayoutPart childThatChanged)(Code)

setBounds
public void setBounds(Rectangle r)(Code)
Sets the presentation bounds.

setContainer
public void setContainer(ILayoutContainer container)(Code)
Sets the parent for this part.

setFocus
public void setFocus()(Code)
Sets focus to this part.

setID
public void setID(String str)(Code)
Sets the part ID.

setVisible
public void setVisible(boolean makeVisible)(Code)
Shows the receiver if visible is true otherwise hide it.

setZoomed
public void setZoomed(boolean isZoomed)(Code)

startDeferringEvents
protected void startDeferringEvents()(Code)
This is called when deferUpdates(true) causes UI events for this part to be deferred. Subclasses can overload to initialize any data structures that they will use to collect deferred events.

testInvariants
public void testInvariants()(Code)
Tests the integrity of this object. Throws an exception if the object's state is not internally consistent. For use in test suites.

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

All other trademarks are property of their respective owners.