oracle.jdeveloper.vcs.vop
Interface DisplayProperty

public interface DisplayProperty

Metadata about a read only property displayed in the version operation panel.

Method Summary

int	getAlignment() Get the alignment of this property.
java.util.Comparator	getComparator() Get a comparator that can sort Displayable instances by this property.
java.lang.String	getDescription() Get a description of this property.
int	getMaximumDefaultSize() Get a maximum default size for the property.
java.lang.String	getName() Get the name of the property.
java.lang.Object	getPrototypeValue() Get a prototype value for this property.
java.lang.Class	getType() Get the type of object that values of this property are represented by.
boolean	isEditable() If return true the property will be editable

Method Detail

getName

java.lang.String getName()

Get the name of the property.

Returns:

a user-readable string which is the name of this property.

getDescription

java.lang.String getDescription()

Get a description of this property.

Returns:

a user-readable string which describes this property, can be null.

getType

java.lang.Class getType()

Get the type of object that values of this property are represented by.

Returns:

a Class instance. The VersionOperationModel.getPropertyValue() method should return objects of this class for this property.

getComparator

java.util.Comparator getComparator()

Get a comparator that can sort Displayable instances by this property.

Returns:

a comparator that can sort Displayable instances by this property. If no comparator is provided (null is returned), a comparator is used that sorts Displayables by the toString() value of this property in their natural ( alphabetical ) order.

getAlignment

int getAlignment()

Get the alignment of this property. Each property can be aligned left, center or right. This is used as a "display hint" when the property is displayed in a tabluar form.

Returns:

SwingUtilities.LEFT, SwingUtilities.CENTER, or SwingUtilities.RIGHT

getPrototypeValue

java.lang.Object getPrototypeValue()

Get a prototype value for this property. This is used as a "display hint" when the property is displayed in a tabular form, you can safely return null.

Returns:

a prototype value for this property, should be an instance of the class returned by getType().

getMaximumDefaultSize

int getMaximumDefaultSize()

Get a maximum default size for the property. This is used to restrict the property size to a sensible maximum when it is based on property values.

Returns:

a maxumum default pixel size for the property.

isEditable

boolean isEditable()

If return true the property will be editable

Returns:

true if want to make the property editable