Eclipse Plug-in Developer Guide (Galileo) - PropertyEditingSupport (Eclipse Platform API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Eclipse Platform
Release 3.5

PREV CLASS NEXT CLASS

NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.ui.views.properties
Class PropertyEditingSupport


java.lang.Object
  

org.eclipse.jface.viewers.EditingSupport
      
org.eclipse.ui.views.properties.PropertyEditingSupport

public class PropertyEditingSupport
extends EditingSupport
extends EditingSupport

A concrete subclass of EditingSupport that implements cell editing support for column-based viewers (such as e.g. TreeViewer or TableViewer) based on an IPropertySourceProvider, forwarding requests to the IPropertySource or IPropertyDescriptor for the given property ID.

Since:: 3.3
See Also:: PropertyColumnLabelProvider

Field Summary

protected Object propertyID


protected IPropertySourceProvider propertySourceProvider


Constructor Summary

PropertyEditingSupport ( ColumnViewer viewer, IPropertySourceProvider propertySourceProvider, Object propertyID)
          Creates a new instance to be used with the given viewer, based on the given property source provider and property ID.

Method Summary

protected boolean canEdit ( Object object)
          Is the cell editable

protected CellEditor getCellEditor ( Object object)
          The editor to be shown

protected Object getValue ( Object object)
          Get the value to set to the editor

protected void setValue ( Object object, Object value)
          Sets the new value on the given element.

Methods inherited from class org.eclipse.jface.viewers. EditingSupport

getViewer, initializeCellEditorValue, saveCellEditorValue

Methods inherited from class java.lang. Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

propertySourceProvider

protected 
IPropertySourceProvider propertySourceProvider

propertyID

protected 
Object propertyID

Constructor Detail

PropertyEditingSupport

public PropertyEditingSupport(
ColumnViewer viewer,
                              
IPropertySourceProvider propertySourceProvider,
                              
Object propertyID)

Creates a new instance to be used with the given viewer, based on the given property source provider and property ID.

Parameters:: viewer - the column viewer; propertySourceProvider - the property source provider; propertyID - the property ID

Method Detail

canEdit

protected boolean canEdit(
Object object)

Description copied from class: EditingSupport

Is the cell editable

Specified by:: canEdit in class EditingSupport

Parameters:: object - the model element
Returns:: true if editable

getCellEditor

protected 
CellEditor getCellEditor(
Object object)

Description copied from class: EditingSupport

The editor to be shown

Specified by:: getCellEditor in class EditingSupport

Parameters:: object - the model element
Returns:: the CellEditor

getValue

protected 
Object getValue(
Object object)

Description copied from class: EditingSupport

Get the value to set to the editor

Specified by:: getValue in class EditingSupport

Parameters:: object - the model element
Returns:: the value shown

setValue

protected void setValue(
Object object,
                        
Object value)

Description copied from class: EditingSupport

Sets the new value on the given element. Note that implementers need to ensure that getViewer().update(element, null) or similar methods are called, either directly or through some kind of listener mechanism on the implementer's model, to cause the new value to appear in the viewer.

Subclasses should overwrite.