Package pyjamas :: Package ui :: Module CheckBox :: Class CheckBox

Class CheckBox

              object --+                    
                       |                    
                 Applier --+                
                           |                
           UIObject.UIObject --+            
                               |            
                   Widget.Widget --+        
                                   |        
      FocusListener.FocusHandler --+        
                                   |        
KeyboardListener.KeyboardHandler --+        
                                   |        
                      object --+   |        
                               |   |        
      MouseListener.MouseHandler --+        
                                   |        
                      object --+   |        
                               |   |        
      ClickListener.ClickHandler --+        
                                   |        
                Focus.FocusMixin --+        
                                   |        
             FocusWidget.FocusWidget --+    
                                       |    
                          object --+   |    
                                   |   |    
                 InnerHTML.InnerHTML --+    
                                       |    
                          object --+   |    
                                   |   |    
                 InnerText.InnerText --+    
                                       |    
                   ButtonBase.ButtonBase --+
                                           |
                                          CheckBox

Instance Methods

[hide private]

__init__(self, label=None, asHTML=False, **ka)
use this to apply properties as a dictionary, e.g.:

source code

sinkEvents(self, eventBitsToAdd)
Unlike other widgets the CheckBox sinks on its inputElement, not its wrapper

source code

initElement(self, element, **ka)

source code

getUniqueID(self)

source code

getHTML(self)

source code

getName(self)

source code

getText(self)

source code

setChecked(self, checked)

source code

isChecked(self)
XXX this function is deprecated: use getChecked

source code

getChecked(self)

source code

isEnabled(self)
XXX this function is deprecated: use getEnabled

source code

getEnabled(self)

source code

setEnabled(self, enabled)

source code

setFocus(self, focused)

source code

setHTML(self, html)

source code

setName(self, name)

source code

setTabIndex(self, index)

source code

setText(self, text)

source code

onDetach(self)
Called when this widget is being removed from the DOM tree of the document.

source code

Inherited from ButtonBase.ButtonBase (private): _setWeirdProps

Inherited from Widget.Widget: doAttachChildren, doDetachChildren, getID, getLayoutData, getParent, isAttached, onAttach, onBrowserEvent, onLoad, removeFromParent, setContextMenu, setID, setLayoutData, setParent

Inherited from UIObject.UIObject: addStyleDependentName, addStyleName, getAbsoluteLeft, getAbsoluteTop, getElement, getHeight, getOffsetHeight, getOffsetWidth, getStyleAttribute, getStyleName, getStylePrimaryName, getTitle, getVisible, getWidth, isVisible, removeStyleDependentName, removeStyleName, setElement, setHeight, setPixelSize, setSize, setStyleAttribute, setStyleName, setTitle, setVisible, setWidth, setzIndex, unsinkEvents

Inherited from Applier: applyValues, retrieveValues, setDefaults, setElementProperties, updateInstance

Inherited from FocusListener.FocusHandler: addFocusListener, onFocus, onLostFocus, removeFocusListener

Inherited from KeyboardListener.KeyboardHandler: addKeyboardListener, onKeyDown, onKeyPress, onKeyUp, removeKeyboardListener

Inherited from MouseListener.MouseHandler: addMouseListener, onMouseDown, onMouseEnter, onMouseGlassEnter, onMouseGlassLeave, onMouseLeave, onMouseMove, onMouseUp, removeMouseListener

Inherited from ClickListener.ClickHandler: addClickListener, addDoubleClickListener, clearClickListener, clearDoubleClickListener, onClick, onDoubleClick, removeClickListener, removeDoubleClickListener

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

Inherited from Focus.FocusMixin: getTabIndex, isReadonly, setAccessKey, setReadonly

Class Methods

[hide private]

_getProps(self)

source code

Inherited from Applier (private): _getElementProps

Class Variables

[hide private]

_props = [("name", "Name", "Name", None),]

Inherited from Applier (private): _elem_props

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

init(self, label=None, asHTML=False, **ka)
(Constructor)

source code

use this to apply properties as a dictionary, e.g.:

   x = klass(..., StyleName='class-name')

will do:

   x = klass(...)
   x.setStyleName('class-name')

and:

   x = klass(..., Size=("100%", "20px"), Visible=False)

will do:

   x = klass(...)
   x.setSize("100%", "20px")
   x.setVisible(False)

Overrides: object.__init__: (inherited documentation)

_getProps(self)
Class Method

source code

Overrides: InnerText.InnerText._getProps

sinkEvents(self, eventBitsToAdd)

source code

Unlike other widgets the CheckBox sinks on its inputElement, not its wrapper

Overrides: UIObject.UIObject.sinkEvents

XXX this function is deprecated: use getEnabled

Overrides: Focus.FocusMixin.isEnabled

setEnabled(self, enabled)

source code

Overrides: Focus.FocusMixin.setEnabled

setFocus(self, focused)

source code

Overrides: Focus.FocusMixin.setFocus

setHTML(self, html)

source code

Overrides: InnerHTML.InnerHTML.setHTML

setTabIndex(self, index)

source code

Overrides: Focus.FocusMixin.setTabIndex

setText(self, text)

source code

Overrides: InnerText.InnerText.setText

onDetach(self)

source code

Called when this widget is being removed from the DOM tree of the document.

Overrides: Widget.Widget.onDetach: (inherited documentation)

Class CheckBox

__init__(self, label=None, asHTML=False, **ka) (Constructor)

_getProps(self) Class Method

sinkEvents(self, eventBitsToAdd)

getHTML(self)

getText(self)

isEnabled(self)

setEnabled(self, enabled)

setFocus(self, focused)

setHTML(self, html)

setTabIndex(self, index)

setText(self, text)

onDetach(self)

init(self, label=None, asHTML=False, **ka)
(Constructor)

_getProps(self)
Class Method