org.zkoss.pivot.event
Class PivotUIEvent

java.lang.Object
  extended by org.zkoss.zk.ui.event.Event
      extended by org.zkoss.pivot.event.PivotUIEvent
All Implemented Interfaces:
java.io.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
static java.lang.String ON_PIVOT_CONTEXT
           
static java.lang.String ON_PIVOT_NODE_OPEN
           
static java.lang.String ON_PIVOT_POPUP
           
static java.lang.String ON_PIVOT_TOOLTIP
           
 
Constructor Summary
PivotUIEvent(java.lang.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(java.lang.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
 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, java.lang.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 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.
 int getX()
          Return the horizontal coordinate of the mouse pointer relative to the component.
 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 Detail

ON_PIVOT_POPUP

public static final java.lang.String ON_PIVOT_POPUP
See Also:
Constant Field Values

ON_PIVOT_CONTEXT

public static final java.lang.String ON_PIVOT_CONTEXT
See Also:
Constant Field Values

ON_PIVOT_TOOLTIP

public static final java.lang.String ON_PIVOT_TOOLTIP
See Also:
Constant Field Values

ON_PIVOT_NODE_OPEN

public static final java.lang.String ON_PIVOT_NODE_OPEN
See Also:
Constant Field Values
Constructor Detail

PivotUIEvent

public PivotUIEvent(java.lang.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(java.lang.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 Detail

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,
                                            java.lang.String key,
                                            int dispIndex)


Copyright © 2013. All Rights Reserved.