|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.birt.report.model.api.GroupPropertyHandle
public class 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 | |
---|---|
protected GroupElementHandle |
handle
Handle to a collection of elements. |
protected org.eclipse.birt.report.model.metadata.ElementPropertyDefn |
propDefn
Definition of the property. |
Method Summary | |
---|---|
void |
clearValue()
Clears the value of the property on every element. |
boolean |
equals(java.lang.Object target)
Compares the specified Object with this GroupPropertyHandle
for equality. |
java.lang.String |
getDisplayValue()
Value will be returned as string only if all values of this property are equal within the collection of elements. |
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. |
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. |
IElementPropertyDefn |
getPropertyDefn()
Return the property definition. |
java.util.List |
getReferenceableElementList()
Returns the element reference value list if the property is element referenceable type. |
java.lang.String |
getStringValue()
Value will be returned as string only if all values of this property are equal within the collection of elements. |
boolean |
isReadOnly()
Checks whether a property is read-only in the property sheet. |
boolean |
isVisible()
Checks whether a property is visible in the property sheet. |
void |
setStringValue(java.lang.String value)
Set the string value on a group of elements. |
void |
setValue(java.lang.Object value)
Set the object value on a group of elements. |
boolean |
shareSameValue()
Indicates whether the group of element share the same value for this property. |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected org.eclipse.birt.report.model.metadata.ElementPropertyDefn propDefn
protected GroupElementHandle handle
Method Detail |
---|
public final boolean shareSameValue()
If all element has a null
value for this property, it is
considered that they share the same value.
true
if the group of element share the same value.public java.lang.String getStringValue()
SimpleValueHandle.getStringValue()
public java.lang.String getLocalStringValue()
protected java.lang.Object getLocalValue()
public java.lang.String getDisplayValue()
SimpleValueHandle.getDisplayValue()
public void setValue(java.lang.Object value) throws SemanticException
value
- the object value to set
SemanticException
- if the property is undefined on an element or the value is
invalid.PropertyHandle.setValue(Object)
public void setStringValue(java.lang.String value) throws SemanticException
value
- the string value to set
SemanticException
- if the property is undefined on an element or the string
value is invalid.SimpleValueHandle.setStringValue(String)
public IElementPropertyDefn getPropertyDefn()
public void clearValue() throws SemanticException
SemanticException
- If the value cannot be cleared.public java.util.List getReferenceableElementList()
public boolean equals(java.lang.Object target)
GroupPropertyHandle
for equality. Returns true
in the following cases:
target
is a PropertyHandle
. The element of
target
is in the GroupElementHandle
and two
property definitions are same. target
is a
GroupPropertyHandle
. GroupElementHandle
and the the
property definition are same.
equals
in class java.lang.Object
target
- the property or group property handle
true
if the two property handles are considerred as
same. Otherwise false
.public boolean isVisible()
elements
.
true
if it is visible. Otherwise false
.public boolean isReadOnly()
elements
.
true
if it is read-only. Otherwise
false
.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |