|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IElementDefn
Interface for a report element definition. This interface defines some methods to get "meta-data" about an element.
Method Summary | |
---|---|
boolean |
allowsUserProperties()
Determines if this element allows user properties. |
boolean |
canContain(int slot,
IElementDefn type)
Reports whether the given slot can contain elements of the given type. |
boolean |
canExtend()
Returns whether elements of this class can be extended. |
java.util.List |
getContents()
Returns the property definitions for this element that can hold other elements. |
java.util.List |
getExpressions()
Returns the expression property definition list of this element definition and parent definition. |
java.util.List |
getGroupNames()
Returns a list of the localized property group names defined by this element and its parents. |
java.util.List |
getLocalExpressions()
Returns the expression property definition list of this element definition. |
java.util.List |
getLocalMethods()
Returns the method definition list of this element definition. |
java.util.List |
getLocalProperties()
Returns properties definitions as a list. |
java.util.List |
getMethods()
Returns the method definition list of this element definition and parent definition. |
int |
getNameOption()
Gets the name option that says how the element type handles names. |
java.util.List |
getProperties()
Returns the properties defined on this element. |
IElementPropertyDefn |
getProperty(java.lang.String propName)
Gets a property definition given a property name. |
ISlotDefn |
getSlot(int slotID)
Returns the meta-data definition for a slot given its numeric slot identifier. |
int |
getSlotCount()
Returns the number of slots in this container. |
boolean |
hasSlot(int slotID)
Returns whether this element has the requested slot given the numeric identifier of the slot. |
boolean |
hasStyle()
Indicates if this element has a style. |
boolean |
isContainer()
Determines if this element acts as a container. |
boolean |
isExtendedElement()
Justifies whether this definition is extension element. |
boolean |
isKindOf(IElementDefn type)
Determines if the given element type is a kind of this type. |
boolean |
isPropertyReadOnly(java.lang.String propName)
Checks whether the property value is read-only in the property sheet. |
boolean |
isPropertyVisible(java.lang.String propName)
Checks whether the property is visible to the property sheet. |
Methods inherited from interface org.eclipse.birt.report.model.api.metadata.IObjectDefn |
---|
findProperty, getDisplayName, getDisplayNameKey, getName, getPropertyIterator, propertiesIterator |
Method Detail |
---|
boolean hasStyle()
java.util.List getProperties()
IElementPropertyDefn
.
java.util.List getLocalProperties()
IElementPropertyDefn
.
IElementPropertyDefn getProperty(java.lang.String propName)
propName
- The name of the property to get.
java.util.List getMethods()
IElementPropertyDefn
.
java.util.List getLocalMethods()
IElementPropertyDefn
.
java.util.List getExpressions()
IElementPropertyDefn
.
java.util.List getLocalExpressions()
IElementPropertyDefn
.
java.util.List getGroupNames()
The UI uses property groups to organize properties within the generic property sheet.
boolean allowsUserProperties()
boolean isContainer()
int getSlotCount()
boolean hasSlot(int slotID)
slotID
- The slotID to check.
ISlotDefn getSlot(int slotID)
slotID
- The slot identifier.
java.util.List getContents()
IPropertyDefn
.
boolean canContain(int slot, IElementDefn type)
slot
- The slot to check.type
- The element type to check.
boolean canExtend()
int getNameOption()
MetaDataConstants
:
MetaDataConstants.NO_NAME
-- The element cannot have a name.
(Probably not used.)MetaDataConstants.OPTIONAL_NAME
--
The element can optionally have a name, but a name is not required.MetaDataConstants.REQUIRED_NAME
-- The element must have a
name.
boolean isPropertyVisible(java.lang.String propName)
propName
- the property name
true
if the element definition has the property
definition and it is visible, false
otherwise.boolean isPropertyReadOnly(java.lang.String propName)
propName
- the property name
true
if the element definition has the property
definition and it is readonly, false
otherwise.boolean isKindOf(IElementDefn type)
type
- The element type to check.
boolean isExtendedElement()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |