|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.birt.report.model.api.DesignElementHandle
org.eclipse.birt.report.model.api.ReportElementHandle
org.eclipse.birt.report.model.api.ReportItemHandle
org.eclipse.birt.report.model.api.ListingHandle
public abstract class ListingHandle
Represents slots and common properties in the two list-oriented elements: table and list. A listing has on-start, on-row and on-finish script properties as well as detail, footer, groups and header slots.
ListingElement
,
SlotHandle
Field Summary |
---|
Fields inherited from class org.eclipse.birt.report.model.api.ReportItemHandle |
---|
DATABINDING_TYPE_DATA, DATABINDING_TYPE_NONE, DATABINDING_TYPE_REPORT_ITEM_REF |
Fields inherited from class org.eclipse.birt.report.model.api.ReportElementHandle |
---|
element |
Fields inherited from class org.eclipse.birt.report.model.api.DesignElementHandle |
---|
module |
Fields inherited from interface org.eclipse.birt.report.model.elements.interfaces.IListingElementModel |
---|
DETAIL_SLOT, FILTER_PROP, FOOTER_SLOT, GROUP_SLOT, HEADER_SLOT, ON_FINISH_METHOD, ON_ROW_METHOD, ON_START_METHOD, PAGE_BREAK_INTERVAL_PROP, REPEAT_HEADER_PROP, SORT_BY_GROUPS_PROP, SORT_PROP |
Fields inherited from interface org.eclipse.birt.report.model.elements.interfaces.IReportItemModel |
---|
ACL_EXPRESSION_PROP, ALLOW_EXPORT_PROP, BOOKMARK_PROP, BOUND_DATA_COLUMNS_PROP, CASCADE_ACL_PROP, CUBE_PROP, DATA_BINDING_REF_PROP, DATA_SET_PROP, HEIGHT_PROP, MULTI_VIEWS_PROP, ON_CREATE_METHOD, ON_PAGE_BREAK_METHOD, ON_PREPARE_METHOD, ON_RENDER_METHOD, PARAM_BINDINGS_PROP, TOC_PROP, VISIBILITY_PROP, WIDTH_PROP, X_PROP, Y_PROP, Z_INDEX_PROP |
Fields inherited from interface org.eclipse.birt.report.model.elements.interfaces.IStyledElementModel |
---|
STYLE_PROP |
Fields inherited from interface org.eclipse.birt.report.model.api.elements.IReportItemMethodContext |
---|
ON_CREATE_CONTEXT, ON_PREPARE_CONTEXT, ON_RENDER_CONTEXT |
Fields inherited from interface org.eclipse.birt.report.model.elements.interfaces.IDesignElementModel |
---|
COMMENTS_PROP, CUSTOM_XML_PROP, DISPLAY_NAME_ID_PROP, DISPLAY_NAME_PROP, EVENT_HANDLER_CLASS_PROP, EXTENDS_PROP, FULL_LABEL, ID_SUFFIX, NAME_PROP, NO_SLOT, PROPERTY_MASKS_PROP, REF_TEMPLATE_PARAMETER_PROP, SHORT_LABEL, USER_LABEL, USER_PROPERTIES_PROP, VIEW_ACTION_PROP |
Constructor Summary | |
---|---|
ListingHandle(org.eclipse.birt.report.model.core.Module module,
org.eclipse.birt.report.model.core.DesignElement element)
Constructs a listing handle with the given design and the element. |
Method Summary | |
---|---|
java.util.Iterator |
filtersIterator()
Returns the iterator for filter list defined on a table or list. |
SlotHandle |
getDetail()
Returns the detail slot. |
SlotHandle |
getFooter()
Returns the footer slot. |
SlotHandle |
getGroups()
Returns the group slot. |
SlotHandle |
getHeader()
Returns the header slot. |
int |
getPageBreakInterval()
Returns the page break interval value |
boolean |
isSortByGroups()
Determines whether the result set of this element will be sorted by the group keys. |
boolean |
repeatHeader()
Tests whether to repeat the headings at the top of each page. |
void |
setPageBreakInterval(int pageBreakInterval)
Sets the page break interval value |
void |
setRepeatHeader(boolean value)
Sets whether to repeat the headings at the top of each page. |
void |
setSortByGroups(boolean isSortByGroups)
Sets whether the result set of this element will be sorted by the group keys. |
java.util.Iterator |
sortsIterator()
Returns the iterator for sort list defined on a table or list. |
Methods inherited from class org.eclipse.birt.report.model.api.ReportElementHandle |
---|
getComments, getCustomXml, getDisplayName, getDisplayNameKey, getElement, getPropertyMask, isValidLayoutForCompoundElement, isValidReferenceForCompoundElement, propertyMaskIterator, setComments, setCustomXml, setDisplayName, setDisplayNameKey, setPropertyMask |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ListingHandle(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.core.DesignElement element)
module
- the moduleelement
- the model representation of the elementMethod Detail |
---|
public SlotHandle getHeader()
public SlotHandle getFooter()
public SlotHandle getDetail()
public SlotHandle getGroups()
public java.util.Iterator sortsIterator()
StructureHandle
that deal with a SortKey
in the list.
SortKey
structure list defined on
a table or list.public java.util.Iterator filtersIterator()
StructureHandle
that deal with a FilterCond
in the list.
FilterCond
structure list defined
on a table or list.public int getPageBreakInterval()
public void setPageBreakInterval(int pageBreakInterval) throws SemanticException
pageBreakInterval
- the page break interval
SemanticException
- if the parameter is not a valid integerpublic boolean repeatHeader()
true
if repeat the headings, otherwise
false
.public void setRepeatHeader(boolean value) throws SemanticException
value
- true
if repeat the headings, otherwise
false
.
SemanticException
- if the property is locked.public boolean isSortByGroups()
public void setSortByGroups(boolean isSortByGroups) throws SemanticException
isSortByGroups
- true if sorted by the groups, otherwise false
SemanticException
- if the property is locked
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |