Package pyjamas :: Package ui :: Module ScrollPanel :: Class ScrollPanel

[frames] | no frames]

Class ScrollPanel

           object --+            
                    |            
      Panel.PanelBase --+        
                        |        
   object --+           |        
            |           |        
      Applier --+       |        
                |       |        
UIObject.UIObject --+   |        
                    |   |        
        Widget.Widget --+        
                        |        
              Panel.Panel --+    
                            |    
      SimplePanel.SimplePanel --+
                                |
                               ScrollPanel

Instance Methods

__init__(self, child=None, **kwargs)
use this to apply properties as a dictionary, e.g.:

source code

addIndexedItem(self, index, item)

source code

getWidgetIndex(self, index)

source code

getIndexedChild(self, index)

source code

addScrollListener(self, listener)

source code

ensureVisible(self, item)

source code

getScrollPosition(self)

source code

getHorizontalScrollPosition(self)

source code

onBrowserEvent(self, event)

source code

removeScrollListener(self, listener)

source code

setAlwaysShowScrollBars(self, alwaysShow)

source code

setScrollPosition(self, position)

source code

setHorizontalScrollPosition(self, position)

source code

ensureVisibleImpl(self, scroll, e)

source code

Inherited from SimplePanel.SimplePanel: add, getContainerElement, getWidget, remove, setWidget

Inherited from Panel.Panel: adopt, disown

Inherited from Panel.PanelBase: __getitem__, __iter__, __len__, __nonzero__, __setitem__, append, clear, doAttachChildren, doDetachChildren, getChildren, getWidgetCount

Inherited from Widget.Widget: getID, getLayoutData, getParent, isAttached, onAttach, onDetach, 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, sinkEvents, unsinkEvents

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

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

Class Methods

_getProps(self)

source code

Inherited from Applier (private): _getElementProps

Class Variables

_props = [("always", "Always show scroll bars", "AlwaysShowScr...

Inherited from Applier (private): _elem_props

Properties

Inherited from object: __class__

Method Details

init(self, child=None, **kwargs)
(Constructor)

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

Overrides: Applier._getProps

addIndexedItem(self, index, item)

Overrides: Panel.PanelBase.addIndexedItem

getWidgetIndex(self, index)

Overrides: Panel.PanelBase.getWidgetIndex

getIndexedChild(self, index)

Overrides: Panel.PanelBase.getIndexedChild

onBrowserEvent(self, event)

Overrides: Widget.Widget.onBrowserEvent

Class Variable Details

_props

Value:

[("always", "Always show scroll bars", "AlwaysShowScrollBars", None), 
("position", "Vertical Scroll Position", "ScrollPosition", None), ("ho
rizPos", "Horizontal Scroll Position", "HorizontalScrollPosition", Non
e),]