Package muntjac :: Package event :: Module item_click_event :: Class ItemClickEvent
[hide private]
[frames] | no frames]

Class ItemClickEvent

source code

      object --+            
               |            
util.EventObject --+        
                   |        
  ui.component.Event --+    
                       |    
 mouse_events.ClickEvent --+
                           |
                          ItemClickEvent

Click event fired by a Component implementing IContainer interface. ItemClickEvents happens on an IItem rendered somehow on terminal. Event may also contain a specific Property on which the click event happened.

Instance Methods [hide private]
 
__init__(self, source, item, itemId, propertyId, details)
Constructs a new event with the specified source component.
source code
 
getItem(self)
Gets the item on which the click event occurred.
source code
 
getItemId(self)
Gets a possible identifier in source for clicked Item.
source code
 
getPropertyId(self)
Returns property on which click event occurred.
source code

Inherited from mouse_events.ClickEvent: getButton, getButtonName, getClientX, getClientY, getRelativeX, getRelativeY, isAltKey, isCtrlKey, isDoubleClick, isMetaKey, isShiftKey

Inherited from ui.component.Event: getComponent

Inherited from util.EventObject: getSource

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Variables [hide private]

Inherited from mouse_events.ClickEvent: BUTTON_LEFT, BUTTON_MIDDLE, BUTTON_RIGHT

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, source, item, itemId, propertyId, details)
(Constructor)

source code 

Constructs a new event with the specified source component.

Parameters:
  • source - the source component of the event
Overrides: object.__init__
(inherited documentation)

getItem(self)

source code 

Gets the item on which the click event occurred.

Returns:
item which was clicked

getPropertyId(self)

source code 

Returns property on which click event occurred. Returns None if source cannot be resolved at property leve. For example if clicked a cell in table, the "column id" is returned.

Returns:
a property id of clicked property or null if click didn't occur on any distinct property.