| org.eclipse.ui.internal.layout.ITrimManager
All known Subclasses: org.eclipse.ui.internal.layout.TrimLayout,
| ITrimManager | | public interface ITrimManager (Code) | | Allow programmatic access to the workbench window trim areas.
Note: This is highly experimental and will change between M4 and M5.
For example, the current trim area IDs will be changes to Strings, amongst
other things.
since:
3.2 |
| Field Summary | |
| final public static int | BOTTOM
Trim area location. | | final public static int | LEFT
Trim area location. | | final public static int | NONTRIM
Trim area location. | | final public static int | RIGHT
Trim area location. | | final public static int | TOP
Trim area location. |
| BOTTOM | | final public static int BOTTOM(Code) | | Trim area location.
|
| LEFT | | final public static int LEFT(Code) | | Trim area location.
|
| NONTRIM | | final public static int NONTRIM(Code) | | Trim area location.
|
| RIGHT | | final public static int RIGHT(Code) | | Trim area location.
|
| TOP | | final public static int TOP(Code) | | Trim area location.
|
| addTrim | | public void addTrim(int areaId, IWindowTrim trim, IWindowTrim beforeMe)(Code) | | Adds the given control to the layout's trim. Note that this must be
called for every trim control. If the given widget is already a trim
widget, it will be moved to the new position. Specifying a position
allows a new widget to be inserted between existing trim widgets.
For example, this method allows the caller to say "insert this new
control as trim along the bottom of the layout, to the left of this
existing control".
Parameters:
trim - new window trim to be added
Parameters:
areaId - the area ID
Parameters:
beforeMe - trim to insert before, null to insert at theend
See Also: ITrimManager.getAreaIds() |
| forceLayout | | public void forceLayout()(Code) | | Force the trim areas to layout to pick up changes
since:
3.2 |
| getAllTrim | | public List getAllTrim()(Code) | | This method returns an aggregate array of all trim items known to this
TrimLayout.
The List of all IWindowTrim elements
since:
3.2 |
| getAreaIds | | public int[] getAreaIds()(Code) | | Return all of the IDs for the currently supported trim areas. This is
experimental and will be changing.
the list of IDs that can be used with area descriptions. Wecurrently support SWT.TOP, SWT.BOTTOM, SWT.LEFT, and SWT.RIGHT.
since:
3.2 |
| getTrim | | public IWindowTrim getTrim(String id)(Code) | | Return the window trim for a given id.
Parameters:
id - the id the window trim, or null if not found. |
| removeTrim | | public void removeTrim(IWindowTrim toRemove)(Code) | | Removes the given window trim. Note that this has no effect if window
trim is not our window trim.
Parameters:
toRemove - a piece of trim. |
| setTrimVisible | | public void setTrimVisible(IWindowTrim trim, boolean visible)(Code) | | Update the visibility of the trim controls. It updates any docking
handles as well. It has no effect on visiblity if the window trim doesn't
belong to this TrimLayout.
Parameters:
trim - the trim to update
Parameters:
visible - visible or not
since:
3.2 |
| updateAreaTrim | | public void updateAreaTrim(int id, List trim, boolean removeExtra)(Code) | | Update ID's area description with the new window trim ordering. This
applies the IWindowTrim contains in the array to the trim area named
"ID".
Parameters:
id - the trim area ID
Parameters:
trim - the trim array must not be null.
Parameters:
removeExtra - if true the any trim in the specified trim areathat's not contained in the List is removed from the windowtrim (but not disposed()). If false then theextra trim is shuffled to the beginning of the trim area.
since:
3.2
See Also: ITrimManager.getAreaIds() |
|
|