|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.jface.viewers.Viewer
public abstract class Viewer
A viewer is a model-based adapter on a widget.
A viewer can be created as an adapter on a pre-existing control (e.g.,
creating a ListViewer
on an existing List
control).
All viewers also provide a convenience constructor for creating the control.
Implementing a concrete viewer typically involves the following steps:
setSelection
, getSelection
)
Field Summary | |
---|---|
protected static java.lang.String |
WIDGET_DATA_KEY
Unique key for associating element data with widgets. |
Constructor Summary | |
---|---|
protected |
Viewer()
Creates a new viewer. |
Method Summary | |
---|---|
void |
addSelectionChangedListener(ISelectionChangedListener listener)
Adds a listener for help requests in this viewer. |
protected void |
fireSelectionChanged(SelectionChangedEvent event)
Notifies any selection changed listeners that the viewer's selection has changed. |
abstract Control |
getControl()
Returns the primary control associated with this viewer. |
java.lang.Object |
getData(java.lang.String key)
Returns the value of the property with the given name, or null if the property is not found. |
abstract java.lang.Object |
getInput()
Returns the input. |
abstract ISelection |
getSelection()
Returns the current selection for this provider. |
protected void |
inputChanged(java.lang.Object input,
java.lang.Object oldInput)
Internal hook method called when the input to this viewer is initially set or subsequently changed. |
abstract void |
refresh()
Refreshes this viewer completely with information freshly obtained from this viewer's model. |
void |
removeSelectionChangedListener(ISelectionChangedListener listener)
Removes the given help listener from this viewer. |
Item |
scrollDown(int x,
int y)
Scrolls the viewer's control down by one item from the given display-relative coordinates. |
Item |
scrollUp(int x,
int y)
Scrolls the viewer's control up by one item from the given display-relative coordinates. |
void |
setData(java.lang.String key,
java.lang.Object value)
Sets the value of the property with the given name to the given value, or to null if the property is to be
removed. |
abstract void |
setInput(java.lang.Object input)
Sets or clears the input for this viewer. |
void |
setSelection(ISelection selection)
The viewer implementation of this ISelectionProvider
method make the new selection for this viewer without making it visible. |
abstract void |
setSelection(ISelection selection,
boolean reveal)
Sets a new selection for this viewer and optionally makes it visible. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected static final java.lang.String WIDGET_DATA_KEY
Widget.setData(String, Object)
,
Constant Field ValuesConstructor Detail |
---|
protected Viewer()
Method Detail |
---|
public void addSelectionChangedListener(ISelectionChangedListener listener)
addSelectionChangedListener
in interface ISelectionProvider
listener
- a help listenerprotected void fireSelectionChanged(SelectionChangedEvent event)
event
- a selection changed eventISelectionChangedListener.selectionChanged(org.eclipse.jface.viewers.SelectionChangedEvent)
public abstract Control getControl()
public java.lang.Object getData(java.lang.String key)
null
if the property is not found.
The default implementation performs a (linear) search of
an internal table. Overriding this method is generally not
required if the number of different keys is small. If a more
efficient representation of a viewer's properties is required,
override both getData
and setData
.
key
- the property name
null
if
the property is not foundpublic abstract java.lang.Object getInput()
IInputProvider
getInput
in interface IInputProvider
public abstract ISelection getSelection()
ISelectionProvider
getSelection
in interface ISelectionProvider
protected void inputChanged(java.lang.Object input, java.lang.Object oldInput)
The default implementation does nothing. Subclassers may override this method to do something when a viewer's input is set. A typical use is populate the viewer.
input
- the new input of this viewer, or null
if noneoldInput
- the old input element or null
if there
was previously no inputpublic abstract void refresh()
public void removeSelectionChangedListener(ISelectionChangedListener listener)
removeSelectionChangedListener
in interface ISelectionProvider
listener
- a help listenerpublic Item scrollDown(int x, int y)
null
if no scrolling occurred or if the viewer
doesn't represent an item-based widget.
x
- horizontal coordinatey
- vertical coordinatepublic Item scrollUp(int x, int y)
null
if no scrolling occurred or if the viewer
doesn't represent an item-based widget.
x
- horizontal coordinatey
- vertical coordinatepublic void setData(java.lang.String key, java.lang.Object value)
null
if the property is to be
removed. If this viewer has such a property, its value is
replaced; otherwise a new property is added.
The default implementation records properties in an internal
table which is searched linearly. Overriding this method is generally not
required if the number of different keys is small. If a more
efficient representation of a viewer's properties is required,
override both getData
and setData
.
key
- the property namevalue
- the property value, or null
if
the property is not foundpublic abstract void setInput(java.lang.Object input)
input
- the input of this viewer, or null
if nonepublic void setSelection(ISelection selection)
ISelectionProvider
method make the new selection for this viewer without making it visible.
This method is equivalent to setSelection(selection,false)
.
setSelection
in interface ISelectionProvider
selection
- the new selectionpublic abstract void setSelection(ISelection selection, boolean reveal)
Subclasses must implement this method.
selection
- the new selectionreveal
- true
if the selection is to be made
visible, and false
otherwise
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |