|
Eclipse Platform Release 3.3 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Represents the main interface between a StackPresentation and the workbench. Not intended to be implemented by clients.
Field Summary | |
---|---|
static int |
STATE_MAXIMIZED
|
static int |
STATE_MINIMIZED
|
static int |
STATE_RESTORED
|
Method Summary | |
---|---|
void |
addSystemActions(IMenuManager menuManager)
Adds system actions to the given menu manager. |
void |
close(IPresentablePart[] toClose)
Closes the given set of parts. |
void |
dragStart(IPresentablePart beingDragged,
Point initialPosition,
boolean keyboard)
Begins dragging the given part |
void |
dragStart(Point initialPosition,
boolean keyboard)
Begins dragging the entire stack of parts |
void |
flushLayout()
Notifies the workbench that the preferred size of the presentation has changed. |
IPresentablePart[] |
getPartList()
Returns the list of presentable parts currently in this site |
String |
getProperty(String id)
Returns the property with the given id or null . |
IPresentablePart |
getSelectedPart()
Returns the currently selected part or null if the stack is empty |
int |
getState()
Returns the current state of the site (one of the STATE_* constants) |
boolean |
isCloseable(IPresentablePart toClose)
Returns true iff this site will allow the given part to be closed |
boolean |
isPartMoveable(IPresentablePart toMove)
Returns true iff the given part can be dragged. |
boolean |
isStackMoveable()
Returns true iff this entire stack can be dragged |
void |
selectPart(IPresentablePart toSelect)
Makes the given part active |
void |
setState(int newState)
Sets the state of the container. |
boolean |
supportsState(int state)
Returns true iff the site supports the given state |
Field Detail |
public static final int STATE_MINIMIZED
public static final int STATE_MAXIMIZED
public static final int STATE_RESTORED
Method Detail |
public void setState(int newState)
newState
- one of the STATE_* constantspublic int getState()
public boolean supportsState(int state)
state
- one of the STATE_* constants, above
public void dragStart(IPresentablePart beingDragged, Point initialPosition, boolean keyboard)
beingDragged
- the part to drag (not null)initialPosition
- the mouse position at the time of the initial mousedown
(display coordinates, not null)keyboard
- true iff the drag was initiated via mouse dragging,
and false if the drag may be using the keyboardpublic void close(IPresentablePart[] toClose)
toClose
- the set of parts to close (Not null. All of the entries must be non-null)public void dragStart(Point initialPosition, boolean keyboard)
initialPosition
- the mouse position at the time of the initial mousedown (display coordinates,
not null)keyboard
- true iff the drag was initiated via mouse dragging,
and false if the drag may be using the keyboardpublic boolean isCloseable(IPresentablePart toClose)
toClose
- part to test (not null)
public boolean isPartMoveable(IPresentablePart toMove)
toMove
- part to test (not null)
public boolean isStackMoveable()
public void selectPart(IPresentablePart toSelect)
toSelect
- public IPresentablePart getSelectedPart()
public void addSystemActions(IMenuManager menuManager)
close
, for close actionssize
, for resize actionsmisc
, for miscellaneous actions
menuManager
- the menu manager to populatepublic void flushLayout()
public IPresentablePart[] getPartList()
public String getProperty(String id)
null
. Folder
properties are an extensible mechanism for perspective authors to
customize the appearance of view stacks. The list of customizable
properties is determined by the presentation factory, and set in the
perspective factory.
id
- Must not be null
.
null
if the property is not
set.
|
Eclipse Platform Release 3.3 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2007. All rights reserved.