org.eclipse.jpt.jpa.ui.details
Interface MappingUiDefinition<M,T>

All Known Subinterfaces:

DefaultJavaAttributeMappingUiDefinition<T>, DefaultJavaTypeMappingUiDefinition<T>, DefaultMappingUiDefinition<M,T>, JavaAttributeMappingUiDefinition<T>, JavaTypeMappingUiDefinition<T>, OrmAttributeMappingUiDefinition<T>, OrmTypeMappingUiDefinition<T>

public interface MappingUiDefinition<M,T>

A UI provider is responsible to provide the support for displaying the information for a certain mapping type. T represents the type of the mapping the definition represents M represents the type of the object being mapped

Since:

2.0 Provisional API: This interface is part of an interim API that is still under development and expected to change significantly before reaching stability. It is available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.

Version:

2.3

Method Summary

org.eclipse.swt.graphics.Image	getImage() Returns an image that represents the mapping type defined by this provider.
java.lang.String	getKey() Returns a unique string that corresponds to the key of the mapping in the core (JavaAttributeMappingDefinition and/or OrmAttributeMappingProvider).
java.lang.String	getLabel() Returns a human readable text of the mapping type.
java.lang.String	getLinkLabel() Returns a human readable text of the mapping type to be used in the mapping change link label
boolean	isEnabledFor(M mappableObject) Return whether the mapping type represented by this definition is enabled for the given mappable object.

Method Detail

getKey

java.lang.String getKey()

Returns a unique string that corresponds to the key of the mapping in the core (JavaAttributeMappingDefinition and/or OrmAttributeMappingProvider).

Returns:

The key representing the mapping

getLabel

java.lang.String getLabel()

Returns a human readable text of the mapping type.

Returns:

A display string for the mapping type

getLinkLabel

java.lang.String getLinkLabel()

Returns a human readable text of the mapping type to be used in the mapping change link label

getImage

org.eclipse.swt.graphics.Image getImage()

Returns an image that represents the mapping type defined by this provider.

Returns:

An image representing a mapping or null if no image is required

isEnabledFor

boolean isEnabledFor(M mappableObject)

Return whether the mapping type represented by this definition is enabled for the given mappable object. This is almost always true.