Package org.eclipse.ui.views.framelist
Class TreeViewerFrameSource
java.lang.Object
org.eclipse.ui.views.framelist.TreeViewerFrameSource
- All Implemented Interfaces:
IFrameSource
Frame source for tree viewers, which uses
TreeFrame to capture
the state of the tree viewer.- See Also:
-
Field Summary
Fields inherited from interface org.eclipse.ui.views.framelist.IFrameSource
CURRENT_FRAME, FULL_CONTEXT, PARENT_FRAME, SELECTION_FRAME -
Constructor Summary
ConstructorsConstructorDescriptionConstructs a new tree viewer frame source for the specified tree viewer. -
Method Summary
Modifier and TypeMethodDescriptionvoidConnects this source as a listener on the frame list, so that when the current frame changes, the viewer is updated.protected TreeFramecreateFrame(Object input) Returns a new tree frame capturing the specified input element.protected voidframeChanged(TreeFrame frame) Updates the viewer in response to the current frame changing.protected FramegetCurrentFrame(int flags) Returns the current frame.getFrame(int whichFrame, int flags) Returns a new frame describing the state of the source.protected FramegetParentFrame(int flags) Returns the parent frame, ornullif there is no parent frame.protected FramegetSelectionFrame(int flags) Returns the frame for the selection, ornullif there is no frame for the selection.Returns the tree viewer.protected voidHandles a property change event from the frame list.
-
Constructor Details
-
TreeViewerFrameSource
Constructs a new tree viewer frame source for the specified tree viewer.- Parameters:
viewer- the tree viewer
-
-
Method Details
-
connectTo
Connects this source as a listener on the frame list, so that when the current frame changes, the viewer is updated. -
createFrame
Returns a new tree frame capturing the specified input element.- Parameters:
input- the input element- Returns:
- the tree frame
-
frameChanged
Updates the viewer in response to the current frame changing.- Parameters:
frame- the new value for the current frame
-
getCurrentFrame
Returns the current frame.- Parameters:
flags- a bit-wise OR of the frame source flag constants- Returns:
- the current frame
-
getFrame
Description copied from interface:IFrameSourceReturns a new frame describing the state of the source. If theFULL_CONTEXTflag is specified, then the full context of the source should be captured by the frame. Otherwise, only the visible aspects of the frame, such as the name and tool tip text, will be used.- Specified by:
getFramein interfaceIFrameSource- Parameters:
whichFrame- one of the frame constants defined in this interfaceflags- a bit-wise OR of the flag constants defined in this interface- Returns:
- a new frame describing the current state of the source
-
getParentFrame
Returns the parent frame, ornullif there is no parent frame.- Parameters:
flags- a bit-wise OR of the frame source flag constants- Returns:
- the parent frame, or
null
-
getSelectionFrame
Returns the frame for the selection, ornullif there is no frame for the selection.- Parameters:
flags- a bit-wise OR of the frame source flag constants- Returns:
- the selection frame, or
null
-
getViewer
Returns the tree viewer.- Returns:
- the tree viewer
-
handlePropertyChange
Handles a property change event from the frame list. CallsframeChangedwhen the current frame changes.
-