| org.eclipse.ui.internal.layout.IWindowTrim
All known Subclasses: org.eclipse.ui.internal.progress.ProgressRegion, org.eclipse.ui.internal.layout.TrimToolBarBase, org.eclipse.ui.internal.FastViewBar, org.eclipse.ui.internal.WindowTrimProxy, org.eclipse.ui.internal.PerspectiveSwitcher,
| IWindowTrim | | public interface IWindowTrim (Code) | | Interface for trim controls that can be docked to the edge of a Workbench
window using drag-and-drop.
Note: This interface is highly experimental, and will probably change
between M4 and M5. For example, it will support a "lifecycle" that allows the
ITrimManager to update its modifiers (like SWT.TOP or SWT.LEFT) so the
IWindowTrim can dispose and re-create its control. This will likely effect
methods like
IWindowTrim.dock(int) ,
IWindowTrim.getControl() ,
IWindowTrim.getValidSides() , etc.
since:
3.2 |
| Method Summary | |
| void | dock(int dropSide)
| | Control | getControl()
Returns the control representing this trim widget, or null if it has not
yet been created. | | public String | getDisplayName()
Returns the (localized) display name for this trim. | | public int | getHeightHint()
Overrides the preferred height of the control (pixels). | | public String | getId()
Each piece of window trim must have a unique ID to participate fully as
trim. | | int | getValidSides()
Returns the set of sides that this trim can be docked onto. | | public int | getWidthHint()
Overrides the preferred width of the control (pixels). | | public void | handleClose()
This method is called when the trim UI has closed (hidden) the trim. | | public boolean | isCloseable()
Determines whether a particular trim can be 'closed' using the common
Trim UI. | | public boolean | isResizeable()
If true, the control will be resized with the layout. |
| dock | | void dock(int dropSide)(Code) | | Called to notify the trim object that it has been docked on the given
side of the layout
Parameters:
dropSide - the trim drop area |
| getControl | | Control getControl()(Code) | | Returns the control representing this trim widget, or null if it has not
yet been created.
the control for the trim widget. |
| getDisplayName | | public String getDisplayName()(Code) | | Returns the (localized) display name for this trim. This is used, for
example, to construct menu items...
The display name for this trim
since:
3.2 |
| getHeightHint | | public int getHeightHint()(Code) | | Overrides the preferred height of the control (pixels). If SWT.DEFAULT,
then the control's preferred height will be used. This has no effect for
vertically resizable controls.
pixels, or SWT.DEFAULT
since:
3.2 |
| getId | | public String getId()(Code) | | Each piece of window trim must have a unique ID to participate fully as
trim.
The unique id
since:
3.2 |
| getValidSides | | int getValidSides()(Code) | | Returns the set of sides that this trim can be docked onto.
bitwise OR of one or more of SWT.TOP, SWT.BOTTOM, SWT.LEFT, andSWT.RIGHT |
| getWidthHint | | public int getWidthHint()(Code) | | Overrides the preferred width of the control (pixels). If SWT.DEFAULT,
then the control's preferred width will be used. This has no effect for
horizontally resizable controls.
pixels, or SWT.DEFAULT
since:
3.2 |
| handleClose | | public void handleClose()(Code) | | This method is called when the trim UI has closed (hidden) the trim. The
controls associated with the trim will have already been removed from the
trim layout. The implementor should take any necessary clean up actions
here.
since:
3.2 |
| isCloseable | | public boolean isCloseable()(Code) | | Determines whether a particular trim can be 'closed' using the common
Trim UI.
true if the UI should profer the close affordance; falseotherwise
since:
3.2 |
| isResizeable | | public boolean isResizeable()(Code) | | If true, the control will be resized with the layout. If there is more
than one resizable control on the same side of the layout, the available
space will be divided equally among all the resizeable controls.
true or false.
since:
3.2 |
|
|