org.eclipse.birt.report.model.api.metadata
Interface IElementPropertyDefn

All Superinterfaces:

IPropertyDefn

All Known Implementing Classes:

org.eclipse.birt.report.model.metadata.ElementPropertyDefn

public interface IElementPropertyDefn

extends IPropertyDefn

Interface of the Meta-data information for an element property or an extension model property. Includes the type, possible choices, display name, etc derived from the IPropertyDefn. It also includes the group name, method information, is visible to the GUI users and can be inherited, etc.

Field Summary

Fields inherited from interface org.eclipse.birt.report.model.api.metadata.IPropertyDefn

EXTENSION_MODEL_PROPERTY, EXTENSION_PROPERTY, ODA_PROPERTY, SYSTEM_PROPERTY, USER_PROPERTY

Method Summary

boolean	canInherit() Indicates if derived elements can inherit the value of this property.
java.lang.String	getGroupName() Returns the group name (if any) for the property.
java.lang.String	getGroupNameKey() Returns the message ID for the group name.
IMethodInfo	getMethodInfo() Returns the method information of this property.
boolean	isEditable() Checks whether the property value can be edited by the user in the property sheet.
boolean	isReadOnly() Deprecated. by the method IElementDefn.isPropertyReadOnly(String)
boolean	isStyleProperty() Indicates whether the property is associated with a style or not.
boolean	isVisible() Deprecated. by the method IElementDefn.isPropertyVisible(String)

Methods inherited from interface org.eclipse.birt.report.model.api.metadata.IPropertyDefn

getAllowedChoices, getChoices, getDefault, getDisplayName, getDisplayNameID, getName, getStructDefn, getTargetElementType, getTypeCode, getValueType, hasChoices, isEncryptable, isList

Method Detail

getGroupName

public java.lang.String getGroupName()

Returns the group name (if any) for the property.

Returns:

The (localized) group name, or null if the property is not in a group.

getGroupNameKey

public java.lang.String getGroupNameKey()

Returns the message ID for the group name.

Returns:

The group name message ID.

canInherit

public boolean canInherit()

Indicates if derived elements can inherit the value of this property. Most properties can inherit values from a parent element. A few system properties, such as the name or extends, can't be inherited.

Note: This attribute is used for both style property and non-style property with two different meanings.

• For style property, it determines whether this property can be cascaded from container;
• For non-style property, that means whether this property can be inherited from parent.

We take it because of the fact style is not inheritable, and the following diagram:

	can inherit	can cascade
Style property	false	isInheritable
Non-style property	isInheritable	false

Returns:

Whether the property can inherit the parent's value.

isStyleProperty

public boolean isStyleProperty()

Indicates whether the property is associated with a style or not. If this property is defined on a style, then isStyleProperty says whether the property can be "associated" with elements that have a style. If so, then each element with a style will include the style property as though that property were defined on the element itself. The meta-data for the style property is copied onto the meta-data for the element. In this case, the copy will also return true from isStyleProperty( ), indicating that the element obtained the property implicitly from the style element.

Returns:

Whether the property is defined on a style for the purpose of being used by elements.

isVisible

public boolean isVisible()

Deprecated. by the method IElementDefn.isPropertyVisible(String)

Checks whether the property is visible to the property sheet.

Returns:

true if the property value is visible, false otherwise.

isReadOnly

public boolean isReadOnly()

Deprecated. by the method IElementDefn.isPropertyReadOnly(String)

Checks whether the property value is read-only in the property sheet.

Returns:

true if the property value is read-only, false otherwise.

getMethodInfo

public IMethodInfo getMethodInfo()

Returns the method information of this property.

Returns:

the method information of this property. Return null, if this property is not a method property.

isEditable

public boolean isEditable()

Checks whether the property value can be edited by the user in the property sheet.

Returns:

true if the property value is read-only, false otherwise.