org.eclipse.gmf.runtime.lite.edit.parts.labels
Interface ILabelTextDisplayer

All Known Implementing Classes:
AbstractFeatureBasedLabelTextDisplayer, AbstractLabelTextDisplayer, CompositeLabelTextDisplayer, ItemProviderLabelTextDisplayer, MessageFormatLabelTextDisplayer, NativeLabelTextDisplayer, PrintfLabelTextDisplayer, RegexpParser, SimpleLabelTextDisplayer

public interface ILabelTextDisplayer

Implementors of this interface are responsible for providing labels representing model elements as well as for making it possible to edit the label and apply the values to the model element.

IMPORTANT: This interface is not intended to be implemented by clients. Clients should inherit from AbstractLabelTextDisplayer. New methods may be added in the future.


Method Summary
 org.eclipse.emf.common.command.Command getApplyCommand(org.eclipse.emf.ecore.EObject source, String newValue)
          Returns the command that applies the new value.
 String getDisplayText(org.eclipse.emf.ecore.EObject source)
          Returns the text a label for the given source object should display.
 String getEditText(org.eclipse.emf.ecore.EObject source)
          Returns the text that should be displayed when the user edits the label.
 org.eclipse.jface.viewers.ICellEditorValidator getValidator()
          Returns the input validator or null if no validation is required.
 boolean isAffectingEvent(org.eclipse.emf.common.notify.Notification notification)
          Returns whether the given notification may cause a source to require update of the label.
 

Method Detail

getDisplayText

String getDisplayText(org.eclipse.emf.ecore.EObject source)
Returns the text a label for the given source object should display.


getEditText

String getEditText(org.eclipse.emf.ecore.EObject source)
Returns the text that should be displayed when the user edits the label.


getValidator

org.eclipse.jface.viewers.ICellEditorValidator getValidator()
Returns the input validator or null if no validation is required.


getApplyCommand

org.eclipse.emf.common.command.Command getApplyCommand(org.eclipse.emf.ecore.EObject source,
                                                       String newValue)
Returns the command that applies the new value.


isAffectingEvent

boolean isAffectingEvent(org.eclipse.emf.common.notify.Notification notification)
Returns whether the given notification may cause a source to require update of the label.



Copyright © 2012. All Rights Reserved.