|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.zkoss.zk.ui.AbstractComponent
org.zkoss.zk.ui.HtmlBasedComponent
org.zkoss.zul.impl.XulElement
org.zkoss.pivot.Pivottable
public class Pivottable
Pivottable component. The component takes a PivotModel to populate data.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class org.zkoss.zk.ui.HtmlBasedComponent |
---|
org.zkoss.zk.ui.HtmlBasedComponent.ExtraCtrl |
Nested classes/interfaces inherited from class org.zkoss.zk.ui.AbstractComponent |
---|
org.zkoss.zk.ui.AbstractComponent.Children |
Field Summary | |
---|---|
static java.lang.String |
COLUMN_TITLE
|
static java.lang.String |
DATA_TITLE
|
static java.lang.String |
ROW_TITLE
|
Fields inherited from class org.zkoss.zk.ui.HtmlBasedComponent |
---|
_zclass |
Fields inherited from interface org.zkoss.zk.ui.Component |
---|
APPLICATION_SCOPE, COMPONENT_SCOPE, DESKTOP_SCOPE, PAGE_SCOPE, REQUEST_SCOPE, SESSION_SCOPE, SPACE_SCOPE |
Fields inherited from interface org.zkoss.zk.ui.sys.ComponentCtrl |
---|
CE_BUSY_IGNORE, CE_DUPLICATE_IGNORE, CE_IMPORTANT, CE_NON_DEFERRABLE, CE_REPEAT_IGNORE |
Constructor Summary | |
---|---|
Pivottable()
|
Method Summary | |
---|---|
boolean |
addTitleCell(java.lang.String type,
org.zkoss.zk.ui.Component component)
Add component in title cells |
void |
beforeChildAdded(org.zkoss.zk.ui.Component newChild,
org.zkoss.zk.ui.Component refChild)
|
void |
clearCustomSizes()
Clear custom sizes adjusted by user. |
java.lang.Object |
clone()
|
int |
getActivePage()
Returns the active page (starting from 0). |
org.zkoss.zk.ui.Component |
getColumnCell()
Return the component in column title cell. |
org.zkoss.zk.ui.Component |
getDataCell()
Return the component in data title cell. |
java.lang.String |
getDataFieldOrient()
Return the value of data field orientation. |
PivotModel |
getModel()
Returns pivot model. |
int |
getPageCount()
Returns the number of pages. |
int |
getPageSize()
Returns the number of items per page. |
PivotRenderer |
getPivotRenderer()
Returns the pivot renderer. |
org.zkoss.zk.ui.Component |
getRowCell()
Return the component in row title cell. |
int |
getTotalSize()
Returns the total number of items. |
java.lang.String |
getZclass()
|
boolean |
insertBefore(org.zkoss.zk.ui.Component newChild,
org.zkoss.zk.ui.Component refChild)
|
boolean |
isChildable()
|
boolean |
isGrandTotalForColumns()
Returns whether enables to show the grand total for columns. |
boolean |
isGrandTotalForRows()
Returns whether enables to show the grand total for rows. |
void |
onChildRemoved(org.zkoss.zk.ui.Component child)
|
void |
onInitRender(org.zkoss.zk.ui.event.Event event)
Only internal use to prepare the rendering information from the pivot model. |
protected void |
renderProperties(org.zkoss.zk.ui.sys.ContentRenderer renderer)
|
void |
service(org.zkoss.zk.au.AuRequest request,
boolean everError)
|
void |
sessionDidActivate(org.zkoss.zk.ui.Page page)
|
void |
sessionWillPassivate(org.zkoss.zk.ui.Page page)
|
void |
setActivePage(int pg)
Set the active page |
void |
setDataFieldOrient(java.lang.String orient)
Set the orientation of data fields, which determines how data are arranged on the Pivottable when there are more than one data fields. |
void |
setGrandTotalForColumns(boolean grandTotalForColumns)
Sets whether enables to show the grand total for columns. |
void |
setGrandTotalForRows(boolean grandTotalForRows)
Sets whether enables to show the grand total for rows. |
void |
setHeight(java.lang.String height)
|
void |
setModel(PivotModel model)
Sets the pivot model. |
void |
setPageSize(int size)
Sets the items to show in each page |
void |
setPivotRenderer(PivotRenderer renderer)
Sets the pivot renderer |
Methods inherited from class org.zkoss.zul.impl.XulElement |
---|
getContext, getCtrlKeys, getPopup, getTooltip, setContext, setContext, setCtrlKeys, setPopup, setPopup, setTooltip, setTooltip |
Methods inherited from class org.zkoss.zk.ui.HtmlBasedComponent |
---|
focus, getAction, getDraggable, getDroppable, getExtraCtrl, getHeight, getHflex, getLeft, getRenderdefer, getSclass, getStyle, getTooltiptext, getTop, getVflex, getWidth, getZindex, getZIndex, setAction, setClass, setDraggable, setDroppable, setFocus, setHeightDirectly, setHflex, setHflexDirectly, setLeft, setLeftDirectly, setRenderdefer, setSclass, setStyle, setTooltiptext, setTop, setTopDirectly, setVflex, setWidth, setWidthDirectly, setZclass, setZindex, setZIndex, setZIndexDirectly |
Methods inherited from class org.zkoss.zk.ui.AbstractComponent |
---|
addAnnotation, addAnnotation, addClientEvent, addEventHandler, addEventListener, addForward, addForward, addForward, addForward, addMoved, addScopeListener, addSharedAnnotationMap, addSharedEventHandlerMap, appendChild, applyProperties, beforeChildRemoved, beforeParentChanged, containsVariable, detach, didActivate, didActivate, didDeserialize, didDeserialize, disableClientUpdate, equals, getAnnotatedProperties, getAnnotatedPropertiesBy, getAnnotation, getAnnotation, getAnnotations, getAnnotations, getAttribute, getAttribute, getAttribute, getAttributeOrFellow, getAttributes, getAttributes, getAuService, getChildren, getClientEvents, getDefaultMold, getDefinition, getDesktop, getEventHandler, getEventHandlerNames, getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getMold, getNamespace, getNextSibling, getPage, getParent, getPreviousSibling, getRoot, getSpaceOwner, getStubonly, getUuid, getVariable, getWidgetAttribute, getWidgetAttributeNames, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttribute, hasAttributeOrFellow, hasFellow, hasFellow, invalidate, isInvalidated, isListenerAvailable, isVisible, newChildren, newExtraCtrl, onChildAdded, onPageAttached, onPageDetached, onWrongValue, redraw, redrawChildren, removeAttribute, removeAttribute, removeAttribute, removeChild, removeEventListener, removeForward, removeForward, removeScopeListener, render, render, render, renderIdSpace, response, response, setAttribute, setAttribute, setAttribute, setAuService, setDefinition, setDefinition, setId, setMold, setPage, setPageBefore, setParent, setStubonly, setVariable, setVisible, setVisibleDirectly, setWidgetAttribute, setWidgetClass, setWidgetListener, setWidgetOverride, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdateWidgetListener, smartUpdateWidgetOverride, toString, unsetVariable, updateByClient, willPassivate, willPassivate, willSerialize, willSerialize |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface org.zkoss.zk.ui.api.HtmlBasedComponent |
---|
focus, getHeight, getLeft, getRenderdefer, getSclass, getStyle, getTooltiptext, getTop, getWidth, getZindex, getZIndex, setDraggable, setDroppable, setFocus, setLeft, setRenderdefer, setSclass, setStyle, setTooltiptext, setTop, setWidth, setZclass, setZindex, setZIndex |
Methods inherited from interface org.zkoss.zk.ui.Component |
---|
addEventListener, addForward, addForward, addForward, addForward, appendChild, applyProperties, containsVariable, detach, getAttribute, getAttribute, getAttributeOrFellow, getAttributes, getAttributes, getAuService, getChildren, getDefinition, getDesktop, getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getMold, getNamespace, getNextSibling, getPage, getParent, getPreviousSibling, getRoot, getSpaceOwner, getStubonly, getUuid, getVariable, getWidgetAttribute, getWidgetAttributeNames, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttributeOrFellow, hasFellow, hasFellow, invalidate, isInvalidated, isListenerAvailable, isVisible, removeAttribute, removeAttribute, removeChild, removeEventListener, removeForward, removeForward, setAttribute, setAttribute, setAuService, setId, setMold, setPage, setPageBefore, setParent, setStubonly, setVariable, setVisible, setWidgetAttribute, setWidgetClass, setWidgetListener, setWidgetOverride, unsetVariable |
Methods inherited from interface org.zkoss.zk.ui.ext.Scope |
---|
addScopeListener, getAttribute, hasAttribute, removeAttribute, removeScopeListener, setAttribute |
Field Detail |
---|
public static final java.lang.String DATA_TITLE
public static final java.lang.String COLUMN_TITLE
public static final java.lang.String ROW_TITLE
Constructor Detail |
---|
public Pivottable()
Method Detail |
---|
public void setHeight(java.lang.String height)
setHeight
in interface org.zkoss.zk.ui.api.HtmlBasedComponent
setHeight
in class org.zkoss.zk.ui.HtmlBasedComponent
public int getPageSize()
Default: 20.
getPageSize
in interface org.zkoss.zul.ext.Pageable
public void setPageSize(int size) throws org.zkoss.zk.ui.WrongValueException
setPageSize
in interface org.zkoss.zul.ext.Pageable
org.zkoss.zk.ui.WrongValueException
public int getTotalSize()
public int getPageCount()
getPageCount
in interface org.zkoss.zul.ext.Pageable
public int getActivePage()
getActivePage
in interface org.zkoss.zul.ext.Pageable
public void setActivePage(int pg) throws org.zkoss.zk.ui.WrongValueException
Note: In server side, active page starts from 0. But in browser UI, it starts from 1
setActivePage
in interface org.zkoss.zul.ext.Pageable
org.zkoss.zk.ui.WrongValueException
public void setGrandTotalForRows(boolean grandTotalForRows)
Default: true
public boolean isGrandTotalForRows()
Default: true.
public void setGrandTotalForColumns(boolean grandTotalForColumns)
Default: true
public boolean isGrandTotalForColumns()
Default: true.
public boolean addTitleCell(java.lang.String type, org.zkoss.zk.ui.Component component)
type
- DATA_TITLE
, COLUMN_TITLE
, ROW_TITLE
public org.zkoss.zk.ui.Component getDataCell()
public org.zkoss.zk.ui.Component getColumnCell()
public org.zkoss.zk.ui.Component getRowCell()
public void beforeChildAdded(org.zkoss.zk.ui.Component newChild, org.zkoss.zk.ui.Component refChild)
beforeChildAdded
in interface org.zkoss.zk.ui.sys.ComponentCtrl
beforeChildAdded
in class org.zkoss.zk.ui.AbstractComponent
public void onChildRemoved(org.zkoss.zk.ui.Component child)
onChildRemoved
in interface org.zkoss.zk.ui.sys.ComponentCtrl
onChildRemoved
in class org.zkoss.zk.ui.AbstractComponent
public boolean insertBefore(org.zkoss.zk.ui.Component newChild, org.zkoss.zk.ui.Component refChild)
insertBefore
in interface org.zkoss.zk.ui.Component
insertBefore
in class org.zkoss.zk.ui.AbstractComponent
public java.lang.String getDataFieldOrient()
column
or row
.
public void setDataFieldOrient(java.lang.String orient)
orient
- accepts either column
or row
.
Throws an exception otherwise.public void clearCustomSizes()
public PivotModel getModel()
public void setModel(PivotModel model)
public void setPivotRenderer(PivotRenderer renderer)
public PivotRenderer getPivotRenderer()
public void onInitRender(org.zkoss.zk.ui.event.Event event)
public java.lang.String getZclass()
getZclass
in interface org.zkoss.zk.ui.api.HtmlBasedComponent
getZclass
in class org.zkoss.zk.ui.HtmlBasedComponent
protected void renderProperties(org.zkoss.zk.ui.sys.ContentRenderer renderer) throws java.io.IOException
renderProperties
in class org.zkoss.zul.impl.XulElement
java.io.IOException
public java.lang.Object clone()
clone
in interface org.zkoss.zk.ui.Component
clone
in class org.zkoss.zul.impl.XulElement
public void sessionWillPassivate(org.zkoss.zk.ui.Page page)
sessionWillPassivate
in interface org.zkoss.zk.ui.sys.ComponentCtrl
sessionWillPassivate
in class org.zkoss.zk.ui.AbstractComponent
public void sessionDidActivate(org.zkoss.zk.ui.Page page)
sessionDidActivate
in interface org.zkoss.zk.ui.sys.ComponentCtrl
sessionDidActivate
in class org.zkoss.zk.ui.AbstractComponent
public boolean isChildable()
isChildable
in class org.zkoss.zk.ui.AbstractComponent
public void service(org.zkoss.zk.au.AuRequest request, boolean everError)
service
in interface org.zkoss.zk.ui.sys.ComponentCtrl
service
in class org.zkoss.zk.ui.HtmlBasedComponent
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |