Class GroupPropertyHandle
- java.lang.Object
-
- org.eclipse.birt.report.model.api.GroupPropertyHandle
-
public class GroupPropertyHandle extends java.lang.ObjectA 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
Fields Modifier and Type Field Description protected GroupElementHandlehandleHandle to a collection of elements.protected org.eclipse.birt.report.model.metadata.ElementPropertyDefnpropDefnDefinition of the property.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidclearValue()Clears the value of the property on every element.booleanequals(java.lang.Object target)Compares the specified Object with thisGroupPropertyHandlefor equality.java.lang.StringgetDisplayValue()Value will be returned as string only if all values of this property are equal within the collection of elements.java.lang.StringgetLocalStringValue()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 java.lang.ObjectgetLocalValue()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.IElementPropertyDefngetPropertyDefn()Return the property definition.java.util.ListgetReferenceableElementList()Returns the element reference value list if the property is element referenceable type.java.lang.StringgetStringValue()Value will be returned as string only if all values of this property are equal within the collection of elements.java.lang.ObjectgetValue()Gets the value of the property.booleanisReadOnly()Checks whether a property is read-only in the property sheet.booleanisVisible()Checks whether a property is visible in the property sheet.voidsetStringValue(java.lang.String value)Set the string value on a group of elements.voidsetValue(java.lang.Object value)Set the object value on a group of elements.booleanshareSameValue()Indicates whether the group of element share the same value for this property.
-
-
-
Field Detail
-
propDefn
protected org.eclipse.birt.report.model.metadata.ElementPropertyDefn propDefn
Definition of the property.
-
handle
protected GroupElementHandle handle
Handle to a collection of elements.
-
-
Method Detail
-
shareSameValue
public final boolean shareSameValue()
Indicates whether the group of element share the same value for this property.If all element has a
nullvalue for this property, it is considered that they share the same value.- Returns:
trueif the group of element share the same value.
-
getStringValue
public java.lang.String 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:
SimpleValueHandle.getStringValue()
-
getLocalStringValue
public java.lang.String 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
protected java.lang.Object 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
public java.lang.String 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:
SimpleValueHandle.getDisplayValue()
-
setValue
public void setValue(java.lang.Object value) throws SemanticExceptionSet 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:
PropertyHandleImpl.setValue(Object)
-
setStringValue
public void setStringValue(java.lang.String value) throws SemanticExceptionSet 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:
SimpleValueHandle.setStringValue(String)
-
getPropertyDefn
public IElementPropertyDefn getPropertyDefn()
Return the property definition.- Returns:
- the property definition.
-
clearValue
public void clearValue() throws SemanticExceptionClears the value of the property on every element.- Throws:
SemanticException- If the value cannot be cleared.
-
getReferenceableElementList
public java.util.List 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
public boolean equals(java.lang.Object target)
Compares the specified Object with thisGroupPropertyHandlefor equality. Returnstruein the following cases:targetis aPropertyHandle. The element oftargetis in theGroupElementHandleand two property definitions are same.targetis aGroupPropertyHandle.GroupElementHandleand the the property definition are same.
- Overrides:
equalsin classjava.lang.Object- Parameters:
target- the property or group property handle- Returns:
trueif the two property handles are considerred as same. Otherwisefalse.
-
isVisible
public boolean isVisible()
Checks whether a property is visible in the property sheet. The visible property is visible in allelements.- Returns:
trueif 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:
trueif it is read-only. Otherwisefalse.
-
getValue
public java.lang.Object 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:
SimpleValueHandle.getValue()
-
-