Class GroupPropertyHandle
java.lang.Object
org.eclipse.birt.report.model.api.GroupPropertyHandle
A handle for working with a top-level property of a collection of elements.
Use this handle to set/get values of a property if this property is common
across the given collection of elements.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected GroupElementHandle
Handle to a collection of elements.protected org.eclipse.birt.report.model.metadata.ElementPropertyDefn
Definition of the property. -
Method Summary
Modifier and TypeMethodDescriptionvoid
Clears the value of the property on every element.boolean
Compares the specified Object with thisGroupPropertyHandle
for equality.Value will be returned as string only if all values of this property are equal within the collection of elements.Value will be returned as string only if all values of this property are equal within the collection of elements and one of them has a local value.protected Object
Value will be returned only if all values of this property are equal within the collection of elements and one of them has a local value.Return the property definition.Returns the element reference value list if the property is element referenceable type.Value will be returned as string only if all values of this property are equal within the collection of elements.getValue()
Gets the value of the property.boolean
Checks whether a property is read-only in the property sheet.boolean
Checks whether a property is visible in the property sheet.void
setStringValue
(String value) Set the string value on a group of elements.void
Set the object value on a group of elements.final boolean
Indicates whether the group of element share the same value for this property.
-
Field Details
-
propDefn
protected org.eclipse.birt.report.model.metadata.ElementPropertyDefn propDefnDefinition of the property. -
handle
Handle to a collection of elements.
-
-
Method Details
-
getStringValue
Value will be returned as string only if all values of this property are equal within the collection of elements.- Returns:
- The value as string if all the element values for the property are equal. Return null, if elements have different value for the property.
- See Also:
-
getLocalStringValue
Value will be returned as string only if all values of this property are equal within the collection of elements and one of them has a local value.- Returns:
- The value as string if all the element values for the property are equal and one of them has a local value. Return null, if elements have different value for the property or none of them has a local value.
-
getLocalValue
Value will be returned only if all values of this property are equal within the collection of elements and one of them has a local value.- Returns:
- The value if all the element values for the property are equal and one of them has a local value. Return null, if elements have different value for the property or none of them has a local value.
-
getDisplayValue
Value will be returned as string only if all values of this property are equal within the collection of elements. The value return are localized.- Returns:
- The localized value as string if all the element values for the property are equal. Return null, if elements have different value for the property.
- See Also:
-
setValue
Set the object value on a group of elements. This operation will be executed within a transaction, it will be rollbacked if any set operation failed.- Parameters:
value
- the object value to set- Throws:
SemanticException
- if the property is undefined on an element or the value is invalid.- See Also:
-
setStringValue
Set the string value on a group of elements. This operation will be executed within a transaction, it will be rollbacked if any set operation failed.- Parameters:
value
- the string value to set- Throws:
SemanticException
- if the property is undefined on an element or the string value is invalid.- See Also:
-
getPropertyDefn
Return the property definition.- Returns:
- the property definition.
-
clearValue
Clears the value of the property on every element.- Throws:
SemanticException
- If the value cannot be cleared.
-
getReferenceableElementList
Returns the element reference value list if the property is element referenceable type. The list of available elements are sorted by their names lexicographically.- Returns:
- list of the reference element value.
-
equals
Compares the specified Object with thisGroupPropertyHandle
for equality. Returnstrue
in the following cases:target
is aPropertyHandle
. The element oftarget
is in theGroupElementHandle
and two property definitions are same.target
is aGroupPropertyHandle
.GroupElementHandle
and the the property definition are same.
-
isVisible
public boolean isVisible()Checks whether a property is visible in the property sheet. The visible property is visible in allelements
.- Returns:
true
if it is visible. Otherwisefalse
.
-
isReadOnly
public boolean isReadOnly()Checks whether a property is read-only in the property sheet. The read-only property is read-only in allelements
.- Returns:
true
if it is read-only. Otherwisefalse
.
-
getValue
Gets the value of the property. Value will be returned as object only if all values of this property are equal within the collection of elements.- Returns:
- The value if all the element values for the property are equal. Return null, if elements have different value for the property.
- See Also: