|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.birt.report.model.api.GroupElementHandle
org.eclipse.birt.report.model.api.SimpleGroupElementHandle
public class SimpleGroupElementHandle
Implements a simple group element handle, which has a non-empty selection element list and root module.
Field Summary | |
---|---|
protected java.util.List |
elements
List of handles to design elements. |
protected org.eclipse.birt.report.model.core.Module |
module
The module that provides overall information, especially the command stack. |
Constructor Summary | |
---|---|
SimpleGroupElementHandle(ModuleHandle moduleHandle,
java.util.List elements)
Constructs a handle to deal with a list of report elements. |
Method Summary | |
---|---|
protected boolean |
allExtendedElements()
Checks if all elements have extends parents or virtual parents. |
void |
clearLocalProperties()
Clears values of all common properties(except the extends property) for the given collection of elements. |
java.util.List |
getCommonProperties()
Returns the common properties shared by the given group of elements(including user properties). |
java.util.List |
getElements()
Returns the list that contains the group of design elements. |
org.eclipse.birt.report.model.core.Module |
getModule()
Returns the module. |
ModuleHandle |
getModuleHandle()
Returns the handle of module. |
GroupPropertyHandle |
getPropertyHandle(java.lang.String propName)
If property is shared by the group of elements, return the corresponding GroupPropertyHandle , otherwise, return null . |
boolean |
isExtendedElements()
Returns true if each of the given collection of element
extends has a parent. |
protected boolean |
isInGroup(DesignElementHandle element)
Checks whether the element is a member of
GroupElementHandle . |
protected boolean |
isPropertyReadOnly(java.lang.String propName)
Checks whether a property is read-only in the property sheet. |
protected boolean |
isPropertyVisible(java.lang.String propName)
Checks whether a property is visible in the property sheet. |
boolean |
isSameType()
Indicates that if the given elements are of the same definition. |
java.util.Iterator |
visiblePropertyIterator()
Returns an iterator over the common properties that are visible. |
Methods inherited from class org.eclipse.birt.report.model.api.GroupElementHandle |
---|
clearProperty, getDisplayProperty, getLocalStringProperty, getStringProperty, hasLocalPropertiesForExtendedElements, propertyIterator, setProperty, setStringProperty, shareSameValue |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected final org.eclipse.birt.report.model.core.Module module
protected java.util.List elements
Constructor Detail |
---|
public SimpleGroupElementHandle(ModuleHandle moduleHandle, java.util.List elements)
moduleHandle
- the handle of moduleelements
- a list of handles of design elements. If a item is not
DesignElementHandle
, it is ignored.DesignElementHandle
Method Detail |
---|
public java.util.List getElements()
GroupElementHandle
DesignElementHandle
getElements
in class GroupElementHandle
public org.eclipse.birt.report.model.core.Module getModule()
GroupElementHandle
getModule
in class GroupElementHandle
public ModuleHandle getModuleHandle()
GroupElementHandle
getModuleHandle
in class GroupElementHandle
public java.util.List getCommonProperties()
GroupElementHandle
getCommonProperties
in class GroupElementHandle
DesignElementHandle
, return an empty list.public boolean isSameType()
GroupElementHandle
If elements have different definitions. Even the same element type, the
return value is false
. For example, if the list contains
an OdaDataSource
and a OdaDataSource
, this
method returns false
.
isSameType
in class GroupElementHandle
true
if the given elements are of the same type;
return false
if elements are of different element
types, or the given list is empty, or the list contains any
object that is not an instance of
DesignElementHandle
.public java.util.Iterator visiblePropertyIterator()
GroupElementHandle
GroupPropertyHandle
. Note: remove is not support for the
iterator.
visiblePropertyIterator
in class GroupElementHandle
GroupPropertyHandle
protected boolean isPropertyVisible(java.lang.String propName)
GroupElementHandle
elements
.
isPropertyVisible
in class GroupElementHandle
propName
- the property name
true
if it is visible. Otherwise
false
.public void clearLocalProperties() throws SemanticException
GroupElementHandle
clearLocalProperties
in class GroupElementHandle
SemanticException
- if the property is not defined on this elementpublic boolean isExtendedElements()
GroupElementHandle
true
if each of the given collection of element
extends has a parent. Returns false
otherwise. If the
collection has no elements, also return false
isExtendedElements
in class GroupElementHandle
true
if each of the given collection of element
extends has a parent. Returns false
otherwise. If
the collection has no elements, also return false
protected boolean allExtendedElements()
GroupElementHandle
allExtendedElements
in class GroupElementHandle
true
If all elements have extend parents or
virtual parents. Otherwise false
;protected boolean isPropertyReadOnly(java.lang.String propName)
GroupElementHandle
elements
.
isPropertyReadOnly
in class GroupElementHandle
propName
- the property name
true
if it is read-only. Otherwise
false
.public GroupPropertyHandle getPropertyHandle(java.lang.String propName)
GroupElementHandle
GroupPropertyHandle
, otherwise, return null
.
getPropertyHandle
in class GroupElementHandle
propName
- name of the property needs to be handled.
GroupPropertyHandle
; Otherwise
return null
.protected boolean isInGroup(DesignElementHandle element)
GroupElementHandle
element
is a member of
GroupElementHandle
.
isInGroup
in class GroupElementHandle
element
- the element to check
true
if the element is in the list, otherwise
false
.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |