Package org.zkoss.pivot.event

Class PivotUIEvent

java.lang.Object

org.zkoss.zk.ui.event.Event

org.zkoss.pivot.event.PivotUIEvent

All Implemented Interfaces:

Serializable

public class PivotUIEvent
extends org.zkoss.zk.ui.event.Event

UI Event on a Pivottable, including onPivotPopup, onPivotContext, onPivotToolTip, onPivotNodeOpen.

Author:

jumperchen

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ON_PIVOT_CONTEXT
static final String	ON_PIVOT_NODE_OPEN
static final String	ON_PIVOT_POPUP
static final String	ON_PIVOT_TOOLTIP

Constructor Summary

Constructors

Constructor	Description
PivotUIEvent(String name, org.zkoss.zk.ui.Component pivottable, boolean open, PivotField.Type pfType, PivotHeaderContext colContext, PivotHeaderContext rowContext, PivotField dataField)	Construct PivotUIEvent for open event.
PivotUIEvent(String name, org.zkoss.zk.ui.Component pivottable, int x, int y, PivotField.Type pfType, PivotHeaderContext colContext, PivotHeaderContext rowContext, PivotField dataField)	Construct PivotUIEvent for popup, tooltip, and context.

Method Summary

Modifier and Type	Method	Description
PivotHeaderContext	getColumnContext()	Return the PivotHeaderContext corresponding to the column slot on which the Event occurs, null if happens on rows.
static PivotHeaderContext	getContext(PivotHeaderTree tree, String key, int dispIndex)
PivotField	getDataField()	Return the data field on which the Event occurs, null if not applicable.
PivotField.Type	getFieldType()	Return the field type on which the Event occurs.
static final PivotUIEvent	getPivotUIEvent(org.zkoss.zk.au.AuRequest request)	Converts an AU request to an pivot UI event.
PivotHeaderContext	getRowContext()	Return the PivotHeaderContext corresponding to the row slot on which the Event occurs, null if happens on columns.
final int	getX()	Return the horizontal coordinate of the mouse pointer relative to the component.
final int	getY()	Return the vertical coordinate of the mouse pointer relative to the component.
boolean	isOpen()	Returns whether the event indicates opening a node.

Methods inherited from class org.zkoss.zk.ui.event.Event

getData, getEvent, getName, getPage, getTarget, isPropagatable, stopPropagation, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

ON_PIVOT_POPUP

public static final String ON_PIVOT_POPUP

See Also:

• Constant Field Values

ON_PIVOT_CONTEXT

public static final String ON_PIVOT_CONTEXT

See Also:

• Constant Field Values

ON_PIVOT_TOOLTIP

public static final String ON_PIVOT_TOOLTIP

See Also:

• Constant Field Values

ON_PIVOT_NODE_OPEN

public static final String ON_PIVOT_NODE_OPEN

See Also:

• Constant Field Values

Constructor Details

PivotUIEvent

public PivotUIEvent(String name,
 org.zkoss.zk.ui.Component pivottable,
 boolean open,
 PivotField.Type pfType,
 PivotHeaderContext colContext,
 PivotHeaderContext rowContext,
 PivotField dataField)

Construct PivotUIEvent for open event.

PivotUIEvent

public PivotUIEvent(String name,
 org.zkoss.zk.ui.Component pivottable,
 int x,
 int y,
 PivotField.Type pfType,
 PivotHeaderContext colContext,
 PivotHeaderContext rowContext,
 PivotField dataField)

Construct PivotUIEvent for popup, tooltip, and context.

Method Details

getPivotUIEvent

public static final PivotUIEvent getPivotUIEvent(org.zkoss.zk.au.AuRequest request)

Converts an AU request to an pivot UI event.

getFieldType

public PivotField.Type getFieldType()

Return the field type on which the Event occurs.

See Also:

• PivotField

getRowContext

public PivotHeaderContext getRowContext()

Return the PivotHeaderContext corresponding to the row slot on which the Event occurs, null if happens on columns.

See Also:

• PivotHeaderContext

getColumnContext

public PivotHeaderContext getColumnContext()

Return the PivotHeaderContext corresponding to the column slot on which the Event occurs, null if happens on rows.

See Also:

• PivotHeaderContext

getDataField

public PivotField getDataField()

Return the data field on which the Event occurs, null if not applicable.

isOpen

public boolean isOpen()

Returns whether the event indicates opening a node. Return false if the event is not a node open event.

getX

public final int getX()

Return the horizontal coordinate of the mouse pointer relative to the component.

getY

public final int getY()

Return the vertical coordinate of the mouse pointer relative to the component.

getContext

public static PivotHeaderContext getContext(PivotHeaderTree tree,
 String key,
 int dispIndex)