org.eclipse.gmt.umlx.editor.property.domains
Interface IDomainProvider<T>

All Known Implementing Classes:
AbstractDomainProvider, ChildEAttributesDomainProvider, ContextDomainProvider, E2AssociationDomainProvider, EAttributesDomainProvider, EClassesDomainProvider, EClassifiersDomainProvider, EDataTypesDomainProvider, EPackagesDomainProvider, GImportsDomainProvider, OCLExpressionTypeDomainProvider, UBindingsDomainProvider, UClassVariablesDomainProvider, UDomainsDomainProvider, UMappingsDomainProvider, UTypedModelClassifiersDomainProvider, UTypedModelsDomainProvider, UVariablesDomainProvider

public interface IDomainProvider<T>

IDomainProvider defines the domain of potential selections for an ObjectListSelectionDialog.


Method Summary
 java.util.Collection<T> getDomain()
          Return the elements that define the domain.
 java.lang.String getElementsTitle()
          Return the text to appear above the list of element selections.
 org.eclipse.swt.graphics.Image getImage(T element)
          Return the Image to display alongside element in the selection list
 java.lang.String getLabel(T element)
          Return the String to display alongside element in the selection list
 T getNullElement()
          Return the element used to denote a null element
 org.eclipse.swt.graphics.Image getParentImage(T element)
          Return the Image to display alongside element's parent in the parent selection list
 java.lang.String getParentLabel(T element)
          Return the String to display alongside element's parent in the parent selection list
 java.lang.String getParentsTitle()
          Return the text to appear above the list of parent selections.
 java.lang.String getTitle()
          Return a descriptive title for the doamin selection
 

Method Detail

getDomain

java.util.Collection<T> getDomain()
Return the elements that define the domain.

Returns:
the domain elements

getElementsTitle

java.lang.String getElementsTitle()
Return the text to appear above the list of element selections.

Returns:
selections title text

getImage

org.eclipse.swt.graphics.Image getImage(T element)
Return the Image to display alongside element in the selection list

Parameters:
element - selection
Returns:
the Image

getLabel

java.lang.String getLabel(T element)
Return the String to display alongside element in the selection list

Parameters:
element - selection
Returns:
the String

getNullElement

T getNullElement()
Return the element used to denote a null element

Returns:
a non-null element if a null element exists, or null if not

getParentImage

org.eclipse.swt.graphics.Image getParentImage(T element)
Return the Image to display alongside element's parent in the parent selection list

Parameters:
element - selection
Returns:
the Image

getParentLabel

java.lang.String getParentLabel(T element)
Return the String to display alongside element's parent in the parent selection list

Parameters:
element - selection
Returns:
the String

getParentsTitle

java.lang.String getParentsTitle()
Return the text to appear above the list of parent selections.

Returns:
parents title text

getTitle

java.lang.String getTitle()
Return a descriptive title for the doamin selection

Returns:
a title