blob: aad359f6b52d4e728f3e1fdda96af84c9232eafa [file] [log] [blame]
package org.eclipse.ui.views.properties;
/*
* (c) Copyright IBM Corp. 2000, 2001.
* All Rights Reserved.
*/
import org.eclipse.jface.viewers.CellEditor;
import org.eclipse.jface.viewers.TextCellEditor;
import org.eclipse.swt.widgets.Composite;
/**
* Descriptor for a property that has a value which should be edited with a
* text cell editor.
* <p>
* This class may be instantiated; it is not intended to be subclassed.
* </p>
* <p>
* Example:
* <pre>
* IPropertyDescriptor pd = new TextPropertyDescriptor("surname", "Last Name");
* </pre>
* </p>
*/
public class TextPropertyDescriptor extends PropertyDescriptor {
/**
* Creates an property descriptor with the given id and display name.
*
* @param id the id of the property
* @param displayName the name to display for the property
*/
public TextPropertyDescriptor(Object id, String displayName) {
super(id, displayName);
}
/**
* The <code>TextPropertyDescriptor</code> implementation of this
* <code>IPropertyDescriptor</code> method creates and returns a new
* <code>TextCellEditor</code>.
* <p>
* The editor is configured with the current validator if there is one.
* </p>
*/
public CellEditor createPropertyEditor(Composite parent) {
CellEditor editor = new TextCellEditor(parent);
if (getValidator() != null)
editor.setValidator(getValidator());
return editor;
}
}