Package org.eclipse.ui.views.framelist
Class TreeViewerFrameSource
- java.lang.Object
-
- org.eclipse.ui.views.framelist.TreeViewerFrameSource
-
- All Implemented Interfaces:
IFrameSource
- Direct Known Subclasses:
NavigatorFrameSource
public class TreeViewerFrameSource extends Object implements IFrameSource
Frame source for tree viewers, which usesTreeFrameto capture the state of the tree viewer.- See Also:
TreeFrame
-
-
Field Summary
-
Fields inherited from interface org.eclipse.ui.views.framelist.IFrameSource
CURRENT_FRAME, FULL_CONTEXT, PARENT_FRAME, SELECTION_FRAME
-
-
Constructor Summary
Constructors Constructor Description TreeViewerFrameSource(AbstractTreeViewer viewer)Constructs a new tree viewer frame source for the specified tree viewer.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidconnectTo(FrameList frameList)Connects 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.FramegetFrame(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.AbstractTreeViewergetViewer()Returns the tree viewer.protected voidhandlePropertyChange(PropertyChangeEvent event)Handles a property change event from the frame list.
-
-
-
Constructor Detail
-
TreeViewerFrameSource
public TreeViewerFrameSource(AbstractTreeViewer viewer)
Constructs a new tree viewer frame source for the specified tree viewer.- Parameters:
viewer- the tree viewer
-
-
Method Detail
-
connectTo
public void connectTo(FrameList frameList)
Connects this source as a listener on the frame list, so that when the current frame changes, the viewer is updated.
-
createFrame
protected TreeFrame createFrame(Object input)
Returns a new tree frame capturing the specified input element.- Parameters:
input- the input element- Returns:
- the tree frame
-
frameChanged
protected void frameChanged(TreeFrame frame)
Updates the viewer in response to the current frame changing.- Parameters:
frame- the new value for the current frame
-
getCurrentFrame
protected Frame getCurrentFrame(int flags)
Returns the current frame.- Parameters:
flags- a bit-wise OR of the frame source flag constants- Returns:
- the current frame
-
getFrame
public Frame getFrame(int whichFrame, int flags)
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
protected Frame getParentFrame(int flags)
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
protected Frame getSelectionFrame(int flags)
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
public AbstractTreeViewer getViewer()
Returns the tree viewer.- Returns:
- the tree viewer
-
handlePropertyChange
protected void handlePropertyChange(PropertyChangeEvent event)
Handles a property change event from the frame list. CallsframeChangedwhen the current frame changes.
-
-