""" This code is auto-generated documentation using a modified version of pydoc.py: http://github.com/lkcl/pyjamas-desktop/tree/master/pyjamas-webkit/pydoc.py To view the documentation that this module shows, you can either compile it to AJAX/javascript using Pyjamas (and then view it in a web browser): http://sf.net/projects/pyjamas or you can run it as a desktop application, using Pyjamas-Desktop: http://sf.net/projects/pyjd """ from pyjamas.ui import Tree, TreeItem, Composite from pyjamas.ui import RootPanel, Label, HTML from pyjamas.ui import DockPanel, HorizontalPanel, VerticalPanel, Grid from pyjamas.ui import FlexTable, TabPanel, ScrollPanel from pyjamas import DOM from pyjamas import Window from pyjamas.DeferredCommand import DeferredCommand class Trees(Composite): def __init__(self, docs, items): Composite.__init__(self) self.docs = docs self.fProto = items self.fTree = Tree() self.fTree.addTreeListener(self) for i in range(len(self.fProto)): self.createItem(self.fProto[i]) item = self.fProto[i].item self.fTree.addItem(item) item.setSelected(True) item.setState(True, True) self.setWidget(self.fTree) def onTreeItemSelected(self, item): self.docs.class_show(item.getText()) def onTreeItemStateChanged(self, item): child = item.getChild(0) if hasattr(child, "isPendingItem"): item.removeItem(child) proto = item.getUserObject() for i in range(len(proto.children)): self.createItem(proto.children[i]) childitem = proto.children[i].item item.addItem(childitem) childitem.setSelected(True) childitem.setState(True, True) def createItem(self, proto): proto.item = TreeItem(proto.text) proto.item.setUserObject(proto) if len(proto.children) > 0: proto.item.addItem(PendingItem()) proto.item.setSelected(True) if proto.item.getTree(): proto.item.setState(True, True) class Proto: def __init__(self, text, children=None): self.children = [] self.item = None self.text = text if children != None: self.children = children class PendingItem(TreeItem): def __init__(self): TreeItem.__init__(self, "Please wait...") def isPendingItem(self): return True def bigtitle(title): return '%s' % title class docui: def modulelink(self, object): """Make a link for a module.""" return '%s' % (object.__name__, object.__name__) def grey(self, text): return '%s' % text def modpkglink(self, args): """Make a link for a module or package to display in an index.""" name = args[0] path = args[1] ispackage = args[2] shadowed = args[3] if shadowed: return self.grey(name) if path: url = '%s.%s.html' % (path, name) else: url = '%s.html' % name if ispackage: text = '%s (package)' % name else: text = name return '%s' % (url, text) def multicolumn(self, items, cols=4): """Format a list of items into a multi-column list.""" result = Grid() result.setWidth("100%") rows = (len(items)+cols-1)/cols result.resize(rows, cols) i = 0 for col in range(cols): for row in range(rows): if items and i < len(items): result.setHTML(row, col, items[i] + "
\n") i += 1 return result def execute(self): self.onWindowResized(Window.getClientWidth(), Window.getClientHeight()) def onBeforeTabSelected(self, sender, tabIndex): return True def onTabSelected(self, sender, tabIndex): self.execute() # do another resize just to be sure. def onWindowResized(self, width, height): pheight = height - self.class_doc.getAbsoluteTop() - 60 self.class_doc.setSize(width, pheight) def onModuleLoad(self): Window.addWindowResizeListener(self) panel = DockPanel() RootPanel().add(panel) self.panel = panel panel.setWidth("100%") #panel.setHeight("100%") panel.setSpacing(5) title = HTML('

ui

') description = HTML("""""") #panel.add(title, DockPanel.NORTH) panel.add(description, DockPanel.NORTH) links = VerticalPanel() links.setSpacing(8) panel.add(links, DockPanel.NORTH) head = HTML("""
 
 
ui		index
/home/lkcl/src/pyjamas-desktop/pyjamas-webkit/pyjamas/ui.py
""") panel.add(head, DockPanel.NORTH) docs = HTML("""This module implements the Pyjamas user-interface widget set for
Pyjamas-Desktop.""") panel.add(docs, DockPanel.NORTH) tp = TabPanel() tp.setWidth("100%") self.tp = tp panel.add(tp, DockPanel.SOUTH) #panel.setCellHeight(tp, "100%") modules = [r'''DOM''',r'''Window''',r'''pygwt''',r'''pyjslib'''] contents = self.multicolumn(modules) title = bigtitle('Modules') contents = section(title, 'module', contents) tp.add(contents, 'Modules') classes = [ Proto('CellFormatter', [ Proto('FlexCellFormatter'), ] ), Proto('DockPanelTmpRow'), Proto('Event'), Proto('EventObject', [ Proto('FormSubmitCompleteEvent'), Proto('FormSubmitEvent'), ] ), Proto('Focus'), Proto('FocusListener'), Proto('HasAlignment'), Proto('HasHorizontalAlignment'), Proto('HasVerticalAlignment'), Proto('KeyboardListener'), Proto('LayoutData'), Proto('MouseListener'), Proto('RowFormatter'), Proto('UIObject', [ Proto('MenuItem'), Proto('TreeItem', [ Proto('RootTreeItem'), ] ), Proto('Widget', [ Proto('Composite', [ Proto('TabBar'), Proto('TabPanel'), ] ), Proto('FileUpload'), Proto('FocusWidget', [ Proto('ButtonBase', [ Proto('Button'), Proto('CheckBox', [ Proto('RadioButton'), ] ), ] ), Proto('ListBox'), Proto('TextBoxBase', [ Proto('PasswordTextBox'), Proto('TextArea'), Proto('TextBox'), ] ), ] ), Proto('Frame', [ Proto('NamedFrame'), ] ), Proto('Hidden'), Proto('Hyperlink'), Proto('Image'), Proto('Label', [ Proto('HTML'), ] ), Proto('MenuBar'), Proto('Panel', [ Proto('ComplexPanel', [ Proto('AbsolutePanel', [ Proto('RootPanelCls'), ] ), Proto('CellPanel', [ Proto('DockPanel'), Proto('HorizontalPanel'), Proto('VerticalPanel'), ] ), Proto('DeckPanel'), Proto('FlowPanel'), Proto('HTMLPanel'), Proto('StackPanel'), ] ), Proto('HTMLTable', [ Proto('FlexTable'), Proto('Grid'), ] ), Proto('SimplePanel', [ Proto('FocusPanel'), Proto('FormPanel'), Proto('PopupPanel', [ Proto('DialogBox'), Proto('MenuBarPopupPanel'), ] ), Proto('ScrollPanel'), Proto('TreeContentPanel'), ] ), ] ), Proto('Tree'), ] ), ] ), ] class_content = { 'TextBoxBase': r'''

 
class TextBoxBase(FocusWidget)
    
Method resolution order:
TextBoxBase
FocusWidget
Widget
UIObject
Methods defined here:
__init__(self, element)
addChangeListener(self, listener)
addClickListener(self, listener)
addKeyboardListener(self, listener)
cancelKey(self)
getCursorPos(self)
getName(self)
getSelectedText(self)
getSelectionLength(self)
getText(self)
onBrowserEvent(self, event)
# BUG: keyboard & click events already fired in FocusWidget.onBrowserEvent
removeChangeListener(self, listener)
removeClickListener(self, listener)
removeKeyboardListener(self, listener)
selectAll(self)
setCursorPos(self, pos)
setKey(self, key)
setName(self, name)
setSelectionRange(self, pos, length)
setText(self, text)
setTextAlignment(self, align)
Data and other attributes defined here:
ALIGN_CENTER = 'center'
ALIGN_JUSTIFY = 'justify'
ALIGN_LEFT = 'left'
ALIGN_RIGHT = 'right'
Methods inherited from FocusWidget:
addFocusListener(self, listener)
getTabIndex(self)
isEnabled(self)
removeFocusListener(self, listener)
setAccessKey(self, key)
setEnabled(self, enabled)
setFocus(self, focused)
setTabIndex(self, index)
Methods inherited from Widget:
getID(self)
Get the id attribute of the associated DOM element.
getLayoutData(self)
getParent(self)
Widgets are kept in a hierarchy, and widgets that have been added to a panel
will have a parent widget that contains them.  This retrieves the containing
widget for this widget.
isAttached(self)
Return whether or not this widget has been attached to the document.
onAttach(self)
Called when this widget has an element, and that element is on the document's
DOM tree, and we have a parent widget.
onDetach(self)
Called when this widget is being removed from the DOM tree of the document.
onLoad(self, sender)
removeFromParent(self)
Remove ourself from our parent.  The parent widget will call setParent(None) on
us automatically
setID(self, id)
Set the id attribute of the associated DOM element.
setLayoutData(self, layoutData)
setParent(self, parent)
Update the parent attribute.  If the parent is currently attached to the DOM this
assumes we are being attached also and calls onAttach().
Methods inherited from UIObject:
addStyleName(self, style)
Append a style to the element associated with this UIObject.  This is
a CSS class name.  It will be added after any already-assigned CSS class for
the element.
getAbsoluteLeft(self)
getAbsoluteTop(self)
getElement(self)
Get the DOM element associated with the UIObject, if any
getOffsetHeight(self)
getOffsetWidth(self)
getStyleName(self)
getTitle(self)
isVisible(self, element=None)
Determine whether this element is currently visible, by checking the CSS
property 'display'
removeStyleName(self, style)
Remove a style from the element associated with this UIObject.  This is
a CSS class name.
setElement(self, element)
Set the DOM element associated with the UIObject.
setHeight(self, height)
Set the height of the element associated with this UIObject.  The
value should be given as a CSS value, such as 100px, 30%, or 50pi
setPixelSize(self, width, height)
Set the width and height of the element associated with this UIObject
in pixels.  Width and height should be numbers.
setSize(self, width, height)
Set the width and height of the element associated with this UIObject.  The
values should be given as a CSS value, such as 100px, 30%, or 50pi
setStyleName(self, element, style=None, add=True)
When called with a single argument, this replaces all the CSS classes
associated with this UIObject's element with the given parameter.  Otherwise,
this is assumed to be a worker function for addStyleName and removeStyleName.
setTitle(self, title)
setVisible(self, element, visible=None)
Set whether this element is visible or not.  If a single parameter is
given, the self.element is used.  This modifies the CSS property 'display',
which means that an invisible element not only is not drawn, but doesn't
occupy any space on the page.
setWidth(self, width)
Set the width of the element associated with this UIObject.  The
value should be given as a CSS value, such as 100px, 30%, or 50pi
setzIndex(self, index)
sinkEvents(self, eventBitsToAdd)
Request that the given events be delivered to the event handler for this
element.  The event bits passed are added (using inclusive OR) to the events
already "sunk" for the element associated with the UIObject.  The event bits
are a combination of values from class L{Event}.
unsinkEvents(self, eventBitsToRemove)
Reverse the operation of sinkEvents.  See L{UIObject.sinkEvents}.
''', 'RootTreeItem': r'''

 
class RootTreeItem(TreeItem)
    
Method resolution order:
RootTreeItem
TreeItem
UIObject
Methods defined here:
addItem(self, item)
removeItem(self, item)
Methods inherited from TreeItem:
__init__(self, html=None)
# also callable as TreeItem(widget)
addTreeItems(self, accum)
clearContentPanel(self)
ensureContentPanel(self)
getChild(self, index)
getChildCount(self)
getChildIndex(self, child)
getChildren(self)
getContentElem(self)
getContentHeight(self)
getFocusableWidget(self)
getHTML(self)
getImageElement(self)
getParentItem(self)
getState(self)
getText(self)
getTree(self)
getTreeTop(self)
getUserObject(self)
getWidget(self)
imgSrc(self, img)
isSelected(self)
remove(self)
removeItems(self)
setHTML(self, html)
setParentItem(self, parent)
setSelected(self, selected)
setState(self, open, fireEvents=True)
setText(self, text)
setTree(self, tree)
setUserObject(self, userObj)
setWidget(self, widget)
updateState(self)
updateStateRecursive(self)
Methods inherited from UIObject:
addStyleName(self, style)
Append a style to the element associated with this UIObject.  This is
a CSS class name.  It will be added after any already-assigned CSS class for
the element.
getAbsoluteLeft(self)
getAbsoluteTop(self)
getElement(self)
Get the DOM element associated with the UIObject, if any
getOffsetHeight(self)
getOffsetWidth(self)
getStyleName(self)
getTitle(self)
isVisible(self, element=None)
Determine whether this element is currently visible, by checking the CSS
property 'display'
removeStyleName(self, style)
Remove a style from the element associated with this UIObject.  This is
a CSS class name.
setElement(self, element)
Set the DOM element associated with the UIObject.
setHeight(self, height)
Set the height of the element associated with this UIObject.  The
value should be given as a CSS value, such as 100px, 30%, or 50pi
setPixelSize(self, width, height)
Set the width and height of the element associated with this UIObject
in pixels.  Width and height should be numbers.
setSize(self, width, height)
Set the width and height of the element associated with this UIObject.  The
values should be given as a CSS value, such as 100px, 30%, or 50pi
setStyleName(self, element, style=None, add=True)
When called with a single argument, this replaces all the CSS classes
associated with this UIObject's element with the given parameter.  Otherwise,
this is assumed to be a worker function for addStyleName and removeStyleName.
setTitle(self, title)
setVisible(self, element, visible=None)
Set whether this element is visible or not.  If a single parameter is
given, the self.element is used.  This modifies the CSS property 'display',
which means that an invisible element not only is not drawn, but doesn't
occupy any space on the page.
setWidth(self, width)
Set the width of the element associated with this UIObject.  The
value should be given as a CSS value, such as 100px, 30%, or 50pi
setzIndex(self, index)
sinkEvents(self, eventBitsToAdd)
Request that the given events be delivered to the event handler for this
element.  The event bits passed are added (using inclusive OR) to the events
already "sunk" for the element associated with the UIObject.  The event bits
are a combination of values from class L{Event}.
unsinkEvents(self, eventBitsToRemove)
Reverse the operation of sinkEvents.  See L{UIObject.sinkEvents}.
''', 'CheckBox': r'''

 
class CheckBox(ButtonBase)
    CheckBox is an input widget which can be checked or unchecked
 
 
Method resolution order:
CheckBox
ButtonBase
FocusWidget
Widget
UIObject
Methods defined here:
__init__(self, label=None, asHTML=False)
Create a new checkbox widget.
 
@param label: Text content to be associated with the checkbox
              (e.g. the checkbox label); see setHTML() and setText()
@param asHTML: the label is HTML rather than plain text
getHTML(self)
getName(self)
getText(self)
getUniqueID(self)
# emulate static
initElement(self, element)
isChecked(self)
isEnabled(self)
onDetach(self)
setChecked(self, checked)
setEnabled(self, enabled)
setFocus(self, focused)
setHTML(self, html)
setName(self, name)
setTabIndex(self, index)
setText(self, text)
Methods inherited from FocusWidget:
addClickListener(self, listener)
addFocusListener(self, listener)
addKeyboardListener(self, listener)
getTabIndex(self)
onBrowserEvent(self, event)
removeClickListener(self, listener)
removeFocusListener(self, listener)
removeKeyboardListener(self, listener)
setAccessKey(self, key)
Methods inherited from Widget:
getID(self)
Get the id attribute of the associated DOM element.
getLayoutData(self)
getParent(self)
Widgets are kept in a hierarchy, and widgets that have been added to a panel
will have a parent widget that contains them.  This retrieves the containing
widget for this widget.
isAttached(self)
Return whether or not this widget has been attached to the document.
onAttach(self)
Called when this widget has an element, and that element is on the document's
DOM tree, and we have a parent widget.
onLoad(self, sender)
removeFromParent(self)
Remove ourself from our parent.  The parent widget will call setParent(None) on
us automatically
setID(self, id)
Set the id attribute of the associated DOM element.
setLayoutData(self, layoutData)
setParent(self, parent)
Update the parent attribute.  If the parent is currently attached to the DOM this
assumes we are being attached also and calls onAttach().
Methods inherited from UIObject:
addStyleName(self, style)
Append a style to the element associated with this UIObject.  This is
a CSS class name.  It will be added after any already-assigned CSS class for
the element.
getAbsoluteLeft(self)
getAbsoluteTop(self)
getElement(self)
Get the DOM element associated with the UIObject, if any
getOffsetHeight(self)
getOffsetWidth(self)
getStyleName(self)
getTitle(self)
isVisible(self, element=None)
Determine whether this element is currently visible, by checking the CSS
property 'display'
removeStyleName(self, style)
Remove a style from the element associated with this UIObject.  This is
a CSS class name.
setElement(self, element)
Set the DOM element associated with the UIObject.
setHeight(self, height)
Set the height of the element associated with this UIObject.  The
value should be given as a CSS value, such as 100px, 30%, or 50pi
setPixelSize(self, width, height)
Set the width and height of the element associated with this UIObject
in pixels.  Width and height should be numbers.
setSize(self, width, height)
Set the width and height of the element associated with this UIObject.  The
values should be given as a CSS value, such as 100px, 30%, or 50pi
setStyleName(self, element, style=None, add=True)
When called with a single argument, this replaces all the CSS classes
associated with this UIObject's element with the given parameter.  Otherwise,
this is assumed to be a worker function for addStyleName and removeStyleName.
setTitle(self, title)
setVisible(self, element, visible=None)
Set whether this element is visible or not.  If a single parameter is
given, the self.element is used.  This modifies the CSS property 'display',
which means that an invisible element not only is not drawn, but doesn't
occupy any space on the page.
setWidth(self, width)
Set the width of the element associated with this UIObject.  The
value should be given as a CSS value, such as 100px, 30%, or 50pi
setzIndex(self, index)
sinkEvents(self, eventBitsToAdd)
Request that the given events be delivered to the event handler for this
element.  The event bits passed are added (using inclusive OR) to the events
already "sunk" for the element associated with the UIObject.  The event bits
are a combination of values from class L{Event}.
unsinkEvents(self, eventBitsToRemove)
Reverse the operation of sinkEvents.  See L{UIObject.sinkEvents}.
''', 'NamedFrame': r'''

 
class NamedFrame(Frame)
    A Frame that has a 'name' associated with it.
This allows the frame to be the target of a FormPanel
 
 
Method resolution order:
NamedFrame
Frame
Widget
UIObject
Methods defined here:
__init__(self, name)
getName(self)
Methods inherited from Frame:
getUrl(self)
setUrl(self, url)
Methods inherited from Widget:
getID(self)
Get the id attribute of the associated DOM element.
getLayoutData(self)
getParent(self)
Widgets are kept in a hierarchy, and widgets that have been added to a panel
will have a parent widget that contains them.  This retrieves the containing
widget for this widget.
isAttached(self)
Return whether or not this widget has been attached to the document.
onAttach(self)
Called when this widget has an element, and that element is on the document's
DOM tree, and we have a parent widget.
onBrowserEvent(self, event)
onDetach(self)
Called when this widget is being removed from the DOM tree of the document.
onLoad(self, sender)
removeFromParent(self)
Remove ourself from our parent.  The parent widget will call setParent(None) on
us automatically
setID(self, id)
Set the id attribute of the associated DOM element.
setLayoutData(self, layoutData)
setParent(self, parent)
Update the parent attribute.  If the parent is currently attached to the DOM this
assumes we are being attached also and calls onAttach().
Methods inherited from UIObject:
addStyleName(self, style)
Append a style to the element associated with this UIObject.  This is
a CSS class name.  It will be added after any already-assigned CSS class for
the element.
getAbsoluteLeft(self)
getAbsoluteTop(self)
getElement(self)
Get the DOM element associated with the UIObject, if any
getOffsetHeight(self)
getOffsetWidth(self)
getStyleName(self)
getTitle(self)
isVisible(self, element=None)
Determine whether this element is currently visible, by checking the CSS
property 'display'
removeStyleName(self, style)
Remove a style from the element associated with this UIObject.  This is
a CSS class name.
setElement(self, element)
Set the DOM element associated with the UIObject.
setHeight(self, height)
Set the height of the element associated with this UIObject.  The
value should be given as a CSS value, such as 100px, 30%, or 50pi
setPixelSize(self, width, height)
Set the width and height of the element associated with this UIObject
in pixels.  Width and height should be numbers.
setSize(self, width, height)
Set the width and height of the element associated with this UIObject.  The
values should be given as a CSS value, such as 100px, 30%, or 50pi
setStyleName(self, element, style=None, add=True)
When called with a single argument, this replaces all the CSS classes
associated with this UIObject's element with the given parameter.  Otherwise,
this is assumed to be a worker function for addStyleName and removeStyleName.
setTitle(self, title)
setVisible(self, element, visible=None)
Set whether this element is visible or not.  If a single parameter is
given, the self.element is used.  This modifies the CSS property 'display',
which means that an invisible element not only is not drawn, but doesn't
occupy any space on the page.
setWidth(self, width)
Set the width of the element associated with this UIObject.  The
value should be given as a CSS value, such as 100px, 30%, or 50pi
setzIndex(self, index)
sinkEvents(self, eventBitsToAdd)
Request that the given events be delivered to the event handler for this
element.  The event bits passed are added (using inclusive OR) to the events
already "sunk" for the element associated with the UIObject.  The event bits
are a combination of values from class L{Event}.
unsinkEvents(self, eventBitsToRemove)
Reverse the operation of sinkEvents.  See L{UIObject.sinkEvents}.
''', 'Label': r'''

 
class Label(Widget)
    A widget that contains arbitrary text, *not* interpreted as HTML.
 
 
Method resolution order:
Label
Widget
UIObject
Methods defined here:
__init__(self, text=None, wordWrap=True)
addClickListener(self, listener)
addMouseListener(self, listener)
getHorizontalAlignment(self)
getText(self)
getWordWrap(self)
onBrowserEvent(self, event)
removeClickListener(self, listener)
removeMouseListener(self, listener)
setHorizontalAlignment(self, align)
setText(self, text)
setWordWrap(self, wrap)
Methods inherited from Widget:
getID(self)
Get the id attribute of the associated DOM element.
getLayoutData(self)
getParent(self)
Widgets are kept in a hierarchy, and widgets that have been added to a panel
will have a parent widget that contains them.  This retrieves the containing
widget for this widget.
isAttached(self)
Return whether or not this widget has been attached to the document.
onAttach(self)
Called when this widget has an element, and that element is on the document's
DOM tree, and we have a parent widget.
onDetach(self)
Called when this widget is being removed from the DOM tree of the document.
onLoad(self, sender)
removeFromParent(self)
Remove ourself from our parent.  The parent widget will call setParent(None) on
us automatically
setID(self, id)
Set the id attribute of the associated DOM element.
setLayoutData(self, layoutData)
setParent(self, parent)
Update the parent attribute.  If the parent is currently attached to the DOM this
assumes we are being attached also and calls onAttach().
Methods inherited from UIObject:
addStyleName(self, style)
Append a style to the element associated with this UIObject.  This is
a CSS class name.  It will be added after any already-assigned CSS class for
the element.
getAbsoluteLeft(self)
getAbsoluteTop(self)
getElement(self)
Get the DOM element associated with the UIObject, if any
getOffsetHeight(self)
getOffsetWidth(self)
getStyleName(self)
getTitle(self)
isVisible(self, element=None)
Determine whether this element is currently visible, by checking the CSS
property 'display'
removeStyleName(self, style)
Remove a style from the element associated with this UIObject.  This is
a CSS class name.
setElement(self, element)
Set the DOM element associated with the UIObject.
setHeight(self, height)
Set the height of the element associated with this UIObject.  The
value should be given as a CSS value, such as 100px, 30%, or 50pi
setPixelSize(self, width, height)
Set the width and height of the element associated with this UIObject
in pixels.  Width and height should be numbers.
setSize(self, width, height)
Set the width and height of the element associated with this UIObject.  The
values should be given as a CSS value, such as 100px, 30%, or 50pi
setStyleName(self, element, style=None, add=True)
When called with a single argument, this replaces all the CSS classes
associated with this UIObject's element with the given parameter.  Otherwise,
this is assumed to be a worker function for addStyleName and removeStyleName.
setTitle(self, title)
setVisible(self, element, visible=None)
Set whether this element is visible or not.  If a single parameter is
given, the self.element is used.  This modifies the CSS property 'display',
which means that an invisible element not only is not drawn, but doesn't
occupy any space on the page.
setWidth(self, width)
Set the width of the element associated with this UIObject.  The
value should be given as a CSS value, such as 100px, 30%, or 50pi
setzIndex(self, index)
sinkEvents(self, eventBitsToAdd)
Request that the given events be delivered to the event handler for this
element.  The event bits passed are added (using inclusive OR) to the events
already "sunk" for the element associated with the UIObject.  The event bits
are a combination of values from class L{Event}.
unsinkEvents(self, eventBitsToRemove)
Reverse the operation of sinkEvents.  See L{UIObject.sinkEvents}.
''', 'DockPanelTmpRow': r'''

 
class DockPanelTmpRow
     Data and other attributes defined here:
center = 0
tr = None
''', 'RowFormatter': r'''

 
class RowFormatter
    RowFormatter is a class for managing formatting of rows in
various types of Panel classes, such as HTMLTable and Grid.
These Panel classes typically use RowFormatter automatically
on your behalf, although you can over-ride that to use your
own RowFormatter class.
 
  Methods defined here:
__init__(self, outer)
addStyleName(self, row, styleName)
ensureElement(self, row)
getElement(self, row)
getRow(self, element, row)
getStyleName(self, row)
isVisible(self, row)
removeStyleName(self, row, styleName)
setAttr(self, row, attrName, value)
setStyleName(self, row, styleName)
setVerticalAlign(self, row, align)
setVisible(self, row, visible)
''', 'HasAlignment': r'''

 
class HasAlignment
     Data and other attributes defined here:
ALIGN_BOTTOM = 'bottom'
ALIGN_CENTER = 'center'
ALIGN_LEFT = 'left'
ALIGN_MIDDLE = 'middle'
ALIGN_RIGHT = 'right'
ALIGN_TOP = 'top'
''', 'DockPanel': r'''

 
class DockPanel(CellPanel)
    A panel that lays its child widgets out "docked" at its outer edges,
and allows its last widget to take up the remaining space in its center.
 
 
Method resolution order:
DockPanel
CellPanel
ComplexPanel
Panel
Widget
UIObject
Methods defined here:
__init__(self)
add(self, widget, direction)
appendAndMaybeAdopt(self, parent, child, beingAdded)
getHorizontalAlignment(self)
getVerticalAlignment(self)
getWidgetDirection(self, widget)
realizeTable(self, beingAdded)
remove(self, widget)
setCellHeight(self, widget, height)
setCellHorizontalAlignment(self, widget, align)
setCellVerticalAlignment(self, widget, align)
setCellWidth(self, widget, width)
setHorizontalAlignment(self, align)
setVerticalAlignment(self, align)
Data and other attributes defined here:
CENTER = 'center'
EAST = 'east'
NORTH = 'north'
SOUTH = 'south'
WEST = 'west'
Methods inherited from CellPanel:
getBody(self)
getSpacing(self)
getTable(self)
getWidgetTd(self, widget)
setBorderWidth(self, width)
setSpacing(self, spacing)
Methods inherited from ComplexPanel:
getChildren(self)
insert(self, widget, container, beforeIndex)
Methods inherited from Panel:
__iter__(self)
adopt(self, widget, container)
clear(self)
# TODO: fix iterator remove()
disown(self, widget)
onAttach(self)
onDetach(self)
Methods inherited from Widget:
getID(self)
Get the id attribute of the associated DOM element.
getLayoutData(self)
getParent(self)
Widgets are kept in a hierarchy, and widgets that have been added to a panel
will have a parent widget that contains them.  This retrieves the containing
widget for this widget.
isAttached(self)
Return whether or not this widget has been attached to the document.
onBrowserEvent(self, event)
onLoad(self, sender)
removeFromParent(self)
Remove ourself from our parent.  The parent widget will call setParent(None) on
us automatically
setID(self, id)
Set the id attribute of the associated DOM element.
setLayoutData(self, layoutData)
setParent(self, parent)
Update the parent attribute.  If the parent is currently attached to the DOM this
assumes we are being attached also and calls onAttach().
Methods inherited from UIObject:
addStyleName(self, style)
Append a style to the element associated with this UIObject.  This is
a CSS class name.  It will be added after any already-assigned CSS class for
the element.
getAbsoluteLeft(self)
getAbsoluteTop(self)
getElement(self)
Get the DOM element associated with the UIObject, if any
getOffsetHeight(self)
getOffsetWidth(self)
getStyleName(self)
getTitle(self)
isVisible(self, element=None)
Determine whether this element is currently visible, by checking the CSS
property 'display'
removeStyleName(self, style)
Remove a style from the element associated with this UIObject.  This is
a CSS class name.
setElement(self, element)
Set the DOM element associated with the UIObject.
setHeight(self, height)
Set the height of the element associated with this UIObject.  The
value should be given as a CSS value, such as 100px, 30%, or 50pi
setPixelSize(self, width, height)
Set the width and height of the element associated with this UIObject
in pixels.  Width and height should be numbers.
setSize(self, width, height)
Set the width and height of the element associated with this UIObject.  The
values should be given as a CSS value, such as 100px, 30%, or 50pi
setStyleName(self, element, style=None, add=True)
When called with a single argument, this replaces all the CSS classes
associated with this UIObject's element with the given parameter.  Otherwise,
this is assumed to be a worker function for addStyleName and removeStyleName.
setTitle(self, title)
setVisible(self, element, visible=None)
Set whether this element is visible or not.  If a single parameter is
given, the self.element is used.  This modifies the CSS property 'display',
which means that an invisible element not only is not drawn, but doesn't
occupy any space on the page.
setWidth(self, width)
Set the width of the element associated with this UIObject.  The
value should be given as a CSS value, such as 100px, 30%, or 50pi
setzIndex(self, index)
sinkEvents(self, eventBitsToAdd)
Request that the given events be delivered to the event handler for this
element.  The event bits passed are added (using inclusive OR) to the events
already "sunk" for the element associated with the UIObject.  The event bits
are a combination of values from class L{Event}.
unsinkEvents(self, eventBitsToRemove)
Reverse the operation of sinkEvents.  See L{UIObject.sinkEvents}.
''', 'HTMLPanel': r'''

 
class HTMLPanel(ComplexPanel)
    A panel that contains HTML, and which can attach child widgets
to identified elements within that HTML.
 
 
Method resolution order:
HTMLPanel
ComplexPanel
Panel
Widget
UIObject
Methods defined here:
__init__(self, html)
add(self, widget, id)
createUniqueId(self)
getElementById(self, element, id)
Methods inherited from ComplexPanel:
getChildren(self)
insert(self, widget, container, beforeIndex)
remove(self, widget)
Methods inherited from Panel:
__iter__(self)
adopt(self, widget, container)
clear(self)
# TODO: fix iterator remove()
disown(self, widget)
onAttach(self)
onDetach(self)
Methods inherited from Widget:
getID(self)
Get the id attribute of the associated DOM element.
getLayoutData(self)
getParent(self)
Widgets are kept in a hierarchy, and widgets that have been added to a panel
will have a parent widget that contains them.  This retrieves the containing
widget for this widget.
isAttached(self)
Return whether or not this widget has been attached to the document.
onBrowserEvent(self, event)
onLoad(self, sender)
removeFromParent(self)
Remove ourself from our parent.  The parent widget will call setParent(None) on
us automatically
setID(self, id)
Set the id attribute of the associated DOM element.
setLayoutData(self, layoutData)
setParent(self, parent)
Update the parent attribute.  If the parent is currently attached to the DOM this
assumes we are being attached also and calls onAttach().
Methods inherited from UIObject:
addStyleName(self, style)
Append a style to the element associated with this UIObject.  This is
a CSS class name.  It will be added after any already-assigned CSS class for
the element.
getAbsoluteLeft(self)
getAbsoluteTop(self)
getElement(self)
Get the DOM element associated with the UIObject, if any
getOffsetHeight(self)
getOffsetWidth(self)
getStyleName(self)
getTitle(self)
isVisible(self, element=None)
Determine whether this element is currently visible, by checking the CSS
property 'display'
removeStyleName(self, style)
Remove a style from the element associated with this UIObject.  This is
a CSS class name.
setElement(self, element)
Set the DOM element associated with the UIObject.
setHeight(self, height)
Set the height of the element associated with this UIObject.  The
value should be given as a CSS value, such as 100px, 30%, or 50pi
setPixelSize(self, width, height)
Set the width and height of the element associated with this UIObject
in pixels.  Width and height should be numbers.
setSize(self, width, height)
Set the width and height of the element associated with this UIObject.  The
values should be given as a CSS value, such as 100px, 30%, or 50pi
setStyleName(self, element, style=None, add=True)
When called with a single argument, this replaces all the CSS classes
associated with this UIObject's element with the given parameter.  Otherwise,
this is assumed to be a worker function for addStyleName and removeStyleName.
setTitle(self, title)
setVisible(self, element, visible=None)
Set whether this element is visible or not.  If a single parameter is
given, the self.element is used.  This modifies the CSS property 'display',
which means that an invisible element not only is not drawn, but doesn't
occupy any space on the page.
setWidth(self, width)
Set the width of the element associated with this UIObject.  The
value should be given as a CSS value, such as 100px, 30%, or 50pi
setzIndex(self, index)
sinkEvents(self, eventBitsToAdd)
Request that the given events be delivered to the event handler for this
element.  The event bits passed are added (using inclusive OR) to the events
already "sunk" for the element associated with the UIObject.  The event bits
are a combination of values from class L{Event}.
unsinkEvents(self, eventBitsToRemove)
Reverse the operation of sinkEvents.  See L{UIObject.sinkEvents}.
''', 'FormSubmitEvent': r'''

 
class FormSubmitEvent(EventObject)
     Methods defined here:
__init__(self, source)
isCancelled(self)
setCancelled(self)
Methods inherited from EventObject:
getSource(self)
''', 'Hidden': r'''

 
class Hidden(Widget)
    Represents a hidden field in a form.
 
 
Method resolution order:
Hidden
Widget
UIObject
Methods defined here:
__init__(self, name=None, value=None)
getDefaultValue(self)
getName(self)
getValue(self)
setDefaultValue(self, defaultValue)
setName(self, name)
setValue(self, value)
Methods inherited from Widget:
getID(self)
Get the id attribute of the associated DOM element.
getLayoutData(self)
getParent(self)
Widgets are kept in a hierarchy, and widgets that have been added to a panel
will have a parent widget that contains them.  This retrieves the containing
widget for this widget.
isAttached(self)
Return whether or not this widget has been attached to the document.
onAttach(self)
Called when this widget has an element, and that element is on the document's
DOM tree, and we have a parent widget.
onBrowserEvent(self, event)
onDetach(self)
Called when this widget is being removed from the DOM tree of the document.
onLoad(self, sender)
removeFromParent(self)
Remove ourself from our parent.  The parent widget will call setParent(None) on
us automatically
setID(self, id)
Set the id attribute of the associated DOM element.
setLayoutData(self, layoutData)
setParent(self, parent)
Update the parent attribute.  If the parent is currently attached to the DOM this
assumes we are being attached also and calls onAttach().
Methods inherited from UIObject:
addStyleName(self, style)
Append a style to the element associated with this UIObject.  This is
a CSS class name.  It will be added after any already-assigned CSS class for
the element.
getAbsoluteLeft(self)
getAbsoluteTop(self)
getElement(self)
Get the DOM element associated with the UIObject, if any
getOffsetHeight(self)
getOffsetWidth(self)
getStyleName(self)
getTitle(self)
isVisible(self, element=None)
Determine whether this element is currently visible, by checking the CSS
property 'display'
removeStyleName(self, style)
Remove a style from the element associated with this UIObject.  This is
a CSS class name.
setElement(self, element)
Set the DOM element associated with the UIObject.
setHeight(self, height)
Set the height of the element associated with this UIObject.  The
value should be given as a CSS value, such as 100px, 30%, or 50pi
setPixelSize(self, width, height)
Set the width and height of the element associated with this UIObject
in pixels.  Width and height should be numbers.
setSize(self, width, height)
Set the width and height of the element associated with this UIObject.  The
values should be given as a CSS value, such as 100px, 30%, or 50pi
setStyleName(self, element, style=None, add=True)
When called with a single argument, this replaces all the CSS classes
associated with this UIObject's element with the given parameter.  Otherwise,
this is assumed to be a worker function for addStyleName and removeStyleName.
setTitle(self, title)
setVisible(self, element, visible=None)
Set whether this element is visible or not.  If a single parameter is
given, the self.element is used.  This modifies the CSS property 'display',
which means that an invisible element not only is not drawn, but doesn't
occupy any space on the page.
setWidth(self, width)
Set the width of the element associated with this UIObject.  The
value should be given as a CSS value, such as 100px, 30%, or 50pi
setzIndex(self, index)
sinkEvents(self, eventBitsToAdd)
Request that the given events be delivered to the event handler for this
element.  The event bits passed are added (using inclusive OR) to the events
already "sunk" for the element associated with the UIObject.  The event bits
are a combination of values from class L{Event}.
unsinkEvents(self, eventBitsToRemove)
Reverse the operation of sinkEvents.  See L{UIObject.sinkEvents}.
''', 'PopupPanel': r'''

 
class PopupPanel(SimplePanel)
    A panel that can "pop up" over other widgets. 
 
The width and height of the PopupPanel cannot be explicitly set;
they are determined by the PopupPanel's widget.
Calls to setWidth(String) and setHeight(String) will call these
methods on the PopupPanel's child widget.
 
 
Method resolution order:
PopupPanel
SimplePanel
Panel
Widget
UIObject
Methods defined here:
__init__(self, autoHide=False)
addPopupListener(self, listener)
createElement(self)
# PopupImpl.createElement
getPopupLeft(self)
getPopupTop(self)
hide(self, autoClosed=False)
onEventPreview(self, event)
onHideImpl(self, popup)
# PopupImpl.onHide
onKeyDownPreview(self, key, modifiers)
onKeyPressPreview(self, key, modifiers)
onKeyUpPreview(self, key, modifiers)
onShowImpl(self, popup)
# PopupImpl.onShow
removePopupListener(self, listener)
setPopupPosition(self, left, top)
show(self)
Methods inherited from SimplePanel:
add(self, widget)
getContainerElement(self)
getWidget(self)
remove(self, widget)
setWidget(self, widget)
Methods inherited from Panel:
__iter__(self)
adopt(self, widget, container)
clear(self)
# TODO: fix iterator remove()
disown(self, widget)
onAttach(self)
onDetach(self)
Methods inherited from Widget:
getID(self)
Get the id attribute of the associated DOM element.
getLayoutData(self)
getParent(self)
Widgets are kept in a hierarchy, and widgets that have been added to a panel
will have a parent widget that contains them.  This retrieves the containing
widget for this widget.
isAttached(self)
Return whether or not this widget has been attached to the document.
onBrowserEvent(self, event)
onLoad(self, sender)
removeFromParent(self)
Remove ourself from our parent.  The parent widget will call setParent(None) on
us automatically
setID(self, id)
Set the id attribute of the associated DOM element.
setLayoutData(self, layoutData)
setParent(self, parent)
Update the parent attribute.  If the parent is currently attached to the DOM this
assumes we are being attached also and calls onAttach().
Methods inherited from UIObject:
addStyleName(self, style)
Append a style to the element associated with this UIObject.  This is
a CSS class name.  It will be added after any already-assigned CSS class for
the element.
getAbsoluteLeft(self)
getAbsoluteTop(self)
getElement(self)
Get the DOM element associated with the UIObject, if any
getOffsetHeight(self)
getOffsetWidth(self)
getStyleName(self)
getTitle(self)
isVisible(self, element=None)
Determine whether this element is currently visible, by checking the CSS
property 'display'
removeStyleName(self, style)
Remove a style from the element associated with this UIObject.  This is
a CSS class name.
setElement(self, element)
Set the DOM element associated with the UIObject.
setHeight(self, height)
Set the height of the element associated with this UIObject.  The
value should be given as a CSS value, such as 100px, 30%, or 50pi
setPixelSize(self, width, height)
Set the width and height of the element associated with this UIObject
in pixels.  Width and height should be numbers.
setSize(self, width, height)
Set the width and height of the element associated with this UIObject.  The
values should be given as a CSS value, such as 100px, 30%, or 50pi
setStyleName(self, element, style=None, add=True)
When called with a single argument, this replaces all the CSS classes
associated with this UIObject's element with the given parameter.  Otherwise,
this is assumed to be a worker function for addStyleName and removeStyleName.
setTitle(self, title)
setVisible(self, element, visible=None)
Set whether this element is visible or not.  If a single parameter is
given, the self.element is used.  This modifies the CSS property 'display',
which means that an invisible element not only is not drawn, but doesn't
occupy any space on the page.
setWidth(self, width)
Set the width of the element associated with this UIObject.  The
value should be given as a CSS value, such as 100px, 30%, or 50pi
setzIndex(self, index)
sinkEvents(self, eventBitsToAdd)
Request that the given events be delivered to the event handler for this
element.  The event bits passed are added (using inclusive OR) to the events
already "sunk" for the element associated with the UIObject.  The event bits
are a combination of values from class L{Event}.
unsinkEvents(self, eventBitsToRemove)
Reverse the operation of sinkEvents.  See L{UIObject.sinkEvents}.
''', 'MenuBar': r'''

 
class MenuBar(Widget)
    A standard menu bar widget. A menu bar can contain any number of
menu items, each of which can either fire a Command or open a
cascaded menu bar.
 
 
Method resolution order:
MenuBar
Widget
UIObject
Methods defined here:
__init__(self, vertical=False)
addItem(self, item, asHTML=None, popup=None)
# also callable as:
#   addItem(item)
#   addItem(text, cmd)
#   addItem(text, popup)
#   addItem(text, asHTML, cmd)
clearItems(self)
close(self)
closeAllParents(self)
doItemAction(self, item, fireCommand)
findItem(self, hItem)
getAutoOpen(self)
getItemContainerElement(self)
itemOver(self, item)
onBrowserEvent(self, event)
onDetach(self)
onHide(self)
onPopupClosed(self, sender, autoClosed)
onShow(self)
removeItem(self, item)
selectItem(self, item)
setAutoOpen(self, autoOpen)
Methods inherited from Widget:
getID(self)
Get the id attribute of the associated DOM element.
getLayoutData(self)
getParent(self)
Widgets are kept in a hierarchy, and widgets that have been added to a panel
will have a parent widget that contains them.  This retrieves the containing
widget for this widget.
isAttached(self)
Return whether or not this widget has been attached to the document.
onAttach(self)
Called when this widget has an element, and that element is on the document's
DOM tree, and we have a parent widget.
onLoad(self, sender)
removeFromParent(self)
Remove ourself from our parent.  The parent widget will call setParent(None) on
us automatically
setID(self, id)
Set the id attribute of the associated DOM element.
setLayoutData(self, layoutData)
setParent(self, parent)
Update the parent attribute.  If the parent is currently attached to the DOM this
assumes we are being attached also and calls onAttach().
Methods inherited from UIObject:
addStyleName(self, style)
Append a style to the element associated with this UIObject.  This is
a CSS class name.  It will be added after any already-assigned CSS class for
the element.
getAbsoluteLeft(self)
getAbsoluteTop(self)
getElement(self)
Get the DOM element associated with the UIObject, if any
getOffsetHeight(self)
getOffsetWidth(self)
getStyleName(self)
getTitle(self)
isVisible(self, element=None)
Determine whether this element is currently visible, by checking the CSS
property 'display'
removeStyleName(self, style)
Remove a style from the element associated with this UIObject.  This is
a CSS class name.
setElement(self, element)
Set the DOM element associated with the UIObject.
setHeight(self, height)
Set the height of the element associated with this UIObject.  The
value should be given as a CSS value, such as 100px, 30%, or 50pi
setPixelSize(self, width, height)
Set the width and height of the element associated with this UIObject
in pixels.  Width and height should be numbers.
setSize(self, width, height)
Set the width and height of the element associated with this UIObject.  The
values should be given as a CSS value, such as 100px, 30%, or 50pi
setStyleName(self, element, style=None, add=True)
When called with a single argument, this replaces all the CSS classes
associated with this UIObject's element with the given parameter.  Otherwise,
this is assumed to be a worker function for addStyleName and removeStyleName.
setTitle(self, title)
setVisible(self, element, visible=None)
Set whether this element is visible or not.  If a single parameter is
given, the self.element is used.  This modifies the CSS property 'display',
which means that an invisible element not only is not drawn, but doesn't
occupy any space on the page.
setWidth(self, width)
Set the width of the element associated with this UIObject.  The
value should be given as a CSS value, such as 100px, 30%, or 50pi
setzIndex(self, index)
sinkEvents(self, eventBitsToAdd)
Request that the given events be delivered to the event handler for this
element.  The event bits passed are added (using inclusive OR) to the events
already "sunk" for the element associated with the UIObject.  The event bits
are a combination of values from class L{Event}.
unsinkEvents(self, eventBitsToRemove)
Reverse the operation of sinkEvents.  See L{UIObject.sinkEvents}.
''', 'Widget': r'''

 
class Widget(UIObject)
    Base class for most of the UI classes.  This class provides basic services
used by any Widget, including management of parents and adding/removing the
event handler association with the DOM.
 
  Methods defined here:
__init__(self)
getID(self)
Get the id attribute of the associated DOM element.
getLayoutData(self)
getParent(self)
Widgets are kept in a hierarchy, and widgets that have been added to a panel
will have a parent widget that contains them.  This retrieves the containing
widget for this widget.
isAttached(self)
Return whether or not this widget has been attached to the document.
onAttach(self)
Called when this widget has an element, and that element is on the document's
DOM tree, and we have a parent widget.
onBrowserEvent(self, event)
onDetach(self)
Called when this widget is being removed from the DOM tree of the document.
onLoad(self, sender)
removeFromParent(self)
Remove ourself from our parent.  The parent widget will call setParent(None) on
us automatically
setID(self, id)
Set the id attribute of the associated DOM element.
setLayoutData(self, layoutData)
setParent(self, parent)
Update the parent attribute.  If the parent is currently attached to the DOM this
assumes we are being attached also and calls onAttach().
Methods inherited from UIObject:
addStyleName(self, style)
Append a style to the element associated with this UIObject.  This is
a CSS class name.  It will be added after any already-assigned CSS class for
the element.
getAbsoluteLeft(self)
getAbsoluteTop(self)
getElement(self)
Get the DOM element associated with the UIObject, if any
getOffsetHeight(self)
getOffsetWidth(self)
getStyleName(self)
getTitle(self)
isVisible(self, element=None)
Determine whether this element is currently visible, by checking the CSS
property 'display'
removeStyleName(self, style)
Remove a style from the element associated with this UIObject.  This is
a CSS class name.
setElement(self, element)
Set the DOM element associated with the UIObject.
setHeight(self, height)
Set the height of the element associated with this UIObject.  The
value should be given as a CSS value, such as 100px, 30%, or 50pi
setPixelSize(self, width, height)
Set the width and height of the element associated with this UIObject
in pixels.  Width and height should be numbers.
setSize(self, width, height)
Set the width and height of the element associated with this UIObject.  The
values should be given as a CSS value, such as 100px, 30%, or 50pi
setStyleName(self, element, style=None, add=True)
When called with a single argument, this replaces all the CSS classes
associated with this UIObject's element with the given parameter.  Otherwise,
this is assumed to be a worker function for addStyleName and removeStyleName.
setTitle(self, title)
setVisible(self, element, visible=None)
Set whether this element is visible or not.  If a single parameter is
given, the self.element is used.  This modifies the CSS property 'display',
which means that an invisible element not only is not drawn, but doesn't
occupy any space on the page.
setWidth(self, width)
Set the width of the element associated with this UIObject.  The
value should be given as a CSS value, such as 100px, 30%, or 50pi
setzIndex(self, index)
sinkEvents(self, eventBitsToAdd)
Request that the given events be delivered to the event handler for this
element.  The event bits passed are added (using inclusive OR) to the events
already "sunk" for the element associated with the UIObject.  The event bits
are a combination of values from class L{Event}.
unsinkEvents(self, eventBitsToRemove)
Reverse the operation of sinkEvents.  See L{UIObject.sinkEvents}.
''', 'FlexCellFormatter': r'''

 
class FlexCellFormatter(CellFormatter)
     Methods defined here:
__init__(self, outer)
getColSpan(self, row, column)
getRowSpan(self, row, column)
setColSpan(self, row, column, colSpan)
setRowSpan(self, row, column, rowSpan)
Methods inherited from CellFormatter:
addStyleName(self, row, column, styleName)
ensureElement(self, row, column)
getAttr(self, row, column, attr)
getCellElement(self, table, row, col)
getElement(self, row, column)
getRawElement(self, row, column)
getStyleName(self, row, column)
isVisible(self, row, column)
removeStyleName(self, row, column, styleName)
setAlignment(self, row, column, hAlign, vAlign)
setAttr(self, row, column, attrName, value)
setHeight(self, row, column, height)
setHorizontalAlignment(self, row, column, align)
setStyleName(self, row, column, styleName)
setVerticalAlignment(self, row, column, align)
setVisible(self, row, column, visible)
setWidth(self, row, column, width)
setWordWrap(self, row, column, wrap)
''', 'HorizontalPanel': r'''

 
class HorizontalPanel(CellPanel)
    A panel that lays all of its widgets out in a single horizontal column.
 
 
Method resolution order:
HorizontalPanel
CellPanel
ComplexPanel
Panel
Widget
UIObject
Methods defined here:
__init__(self)
add(self, widget)
getHorizontalAlignment(self)
getVerticalAlignment(self)
getWidget(self, index)
getWidgetCount(self)
getWidgetIndex(self, child)
insert(self, widget, beforeIndex)
remove(self, widget)
setHorizontalAlignment(self, align)
setVerticalAlignment(self, align)
Methods inherited from CellPanel:
getBody(self)
getSpacing(self)
getTable(self)
getWidgetTd(self, widget)
setBorderWidth(self, width)
setCellHeight(self, widget, height)
setCellHorizontalAlignment(self, widget, align)
setCellVerticalAlignment(self, widget, align)
setCellWidth(self, widget, width)
setSpacing(self, spacing)
Methods inherited from ComplexPanel:
getChildren(self)
Methods inherited from Panel:
__iter__(self)
adopt(self, widget, container)
clear(self)
# TODO: fix iterator remove()
disown(self, widget)
onAttach(self)
onDetach(self)
Methods inherited from Widget:
getID(self)
Get the id attribute of the associated DOM element.
getLayoutData(self)
getParent(self)
Widgets are kept in a hierarchy, and widgets that have been added to a panel
will have a parent widget that contains them.  This retrieves the containing
widget for this widget.
isAttached(self)
Return whether or not this widget has been attached to the document.
onBrowserEvent(self, event)
onLoad(self, sender)
removeFromParent(self)
Remove ourself from our parent.  The parent widget will call setParent(None) on
us automatically
setID(self, id)
Set the id attribute of the associated DOM element.
setLayoutData(self, layoutData)
setParent(self, parent)
Update the parent attribute.  If the parent is currently attached to the DOM this
assumes we are being attached also and calls onAttach().
Methods inherited from UIObject:
addStyleName(self, style)
Append a style to the element associated with this UIObject.  This is
a CSS class name.  It will be added after any already-assigned CSS class for
the element.
getAbsoluteLeft(self)
getAbsoluteTop(self)
getElement(self)
Get the DOM element associated with the UIObject, if any
getOffsetHeight(self)
getOffsetWidth(self)
getStyleName(self)
getTitle(self)
isVisible(self, element=None)
Determine whether this element is currently visible, by checking the CSS
property 'display'
removeStyleName(self, style)
Remove a style from the element associated with this UIObject.  This is
a CSS class name.
setElement(self, element)
Set the DOM element associated with the UIObject.
setHeight(self, height)
Set the height of the element associated with this UIObject.  The
value should be given as a CSS value, such as 100px, 30%, or 50pi
setPixelSize(self, width, height)
Set the width and height of the element associated with this UIObject
in pixels.  Width and height should be numbers.
setSize(self, width, height)
Set the width and height of the element associated with this UIObject.  The
values should be given as a CSS value, such as 100px, 30%, or 50pi
setStyleName(self, element, style=None, add=True)
When called with a single argument, this replaces all the CSS classes
associated with this UIObject's element with the given parameter.  Otherwise,
this is assumed to be a worker function for addStyleName and removeStyleName.
setTitle(self, title)
setVisible(self, element, visible=None)
Set whether this element is visible or not.  If a single parameter is
given, the self.element is used.  This modifies the CSS property 'display',
which means that an invisible element not only is not drawn, but doesn't
occupy any space on the page.
setWidth(self, width)
Set the width of the element associated with this UIObject.  The
value should be given as a CSS value, such as 100px, 30%, or 50pi
setzIndex(self, index)
sinkEvents(self, eventBitsToAdd)
Request that the given events be delivered to the event handler for this
element.  The event bits passed are added (using inclusive OR) to the events
already "sunk" for the element associated with the UIObject.  The event bits
are a combination of values from class L{Event}.
unsinkEvents(self, eventBitsToRemove)
Reverse the operation of sinkEvents.  See L{UIObject.sinkEvents}.
''', 'TextArea': r'''

 
class TextArea(TextBoxBase)
    HTML textarea widget, allowing multi-line text entry.
Use setText/getText to get and access the current text.
 
 
Method resolution order:
TextArea
TextBoxBase
FocusWidget
Widget
UIObject
Methods defined here:
__init__(self)
getCharacterWidth(self)
getCursorPos(self)
getVisibleLines(self)
setCharacterWidth(self, width)
setVisibleLines(self, lines)
Methods inherited from TextBoxBase:
addChangeListener(self, listener)
addClickListener(self, listener)
addKeyboardListener(self, listener)
cancelKey(self)
getName(self)
getSelectedText(self)
getSelectionLength(self)
getText(self)
onBrowserEvent(self, event)
# BUG: keyboard & click events already fired in FocusWidget.onBrowserEvent
removeChangeListener(self, listener)
removeClickListener(self, listener)
removeKeyboardListener(self, listener)
selectAll(self)
setCursorPos(self, pos)
setKey(self, key)
setName(self, name)
setSelectionRange(self, pos, length)
setText(self, text)
setTextAlignment(self, align)
Data and other attributes inherited from TextBoxBase:
ALIGN_CENTER = 'center'
ALIGN_JUSTIFY = 'justify'
ALIGN_LEFT = 'left'
ALIGN_RIGHT = 'right'
Methods inherited from FocusWidget:
addFocusListener(self, listener)
getTabIndex(self)
isEnabled(self)
removeFocusListener(self, listener)
setAccessKey(self, key)
setEnabled(self, enabled)
setFocus(self, focused)
setTabIndex(self, index)
Methods inherited from Widget:
getID(self)
Get the id attribute of the associated DOM element.
getLayoutData(self)
getParent(self)
Widgets are kept in a hierarchy, and widgets that have been added to a panel
will have a parent widget that contains them.  This retrieves the containing
widget for this widget.
isAttached(self)
Return whether or not this widget has been attached to the document.
onAttach(self)
Called when this widget has an element, and that element is on the document's
DOM tree, and we have a parent widget.
onDetach(self)
Called when this widget is being removed from the DOM tree of the document.
onLoad(self, sender)
removeFromParent(self)
Remove ourself from our parent.  The parent widget will call setParent(None) on
us automatically
setID(self, id)
Set the id attribute of the associated DOM element.
setLayoutData(self, layoutData)
setParent(self, parent)
Update the parent attribute.  If the parent is currently attached to the DOM this
assumes we are being attached also and calls onAttach().
Methods inherited from UIObject:
addStyleName(self, style)
Append a style to the element associated with this UIObject.  This is
a CSS class name.  It will be added after any already-assigned CSS class for
the element.
getAbsoluteLeft(self)
getAbsoluteTop(self)
getElement(self)
Get the DOM element associated with the UIObject, if any
getOffsetHeight(self)
getOffsetWidth(self)
getStyleName(self)
getTitle(self)
isVisible(self, element=None)
Determine whether this element is currently visible, by checking the CSS
property 'display'
removeStyleName(self, style)
Remove a style from the element associated with this UIObject.  This is
a CSS class name.
setElement(self, element)
Set the DOM element associated with the UIObject.
setHeight(self, height)
Set the height of the element associated with this UIObject.  The
value should be given as a CSS value, such as 100px, 30%, or 50pi
setPixelSize(self, width, height)
Set the width and height of the element associated with this UIObject
in pixels.  Width and height should be numbers.
setSize(self, width, height)
Set the width and height of the element associated with this UIObject.  The
values should be given as a CSS value, such as 100px, 30%, or 50pi
setStyleName(self, element, style=None, add=True)
When called with a single argument, this replaces all the CSS classes
associated with this UIObject's element with the given parameter.  Otherwise,
this is assumed to be a worker function for addStyleName and removeStyleName.
setTitle(self, title)
setVisible(self, element, visible=None)
Set whether this element is visible or not.  If a single parameter is
given, the self.element is used.  This modifies the CSS property 'display',
which means that an invisible element not only is not drawn, but doesn't
occupy any space on the page.
setWidth(self, width)
Set the width of the element associated with this UIObject.  The
value should be given as a CSS value, such as 100px, 30%, or 50pi
setzIndex(self, index)
sinkEvents(self, eventBitsToAdd)
Request that the given events be delivered to the event handler for this
element.  The event bits passed are added (using inclusive OR) to the events
already "sunk" for the element associated with the UIObject.  The event bits
are a combination of values from class L{Event}.
unsinkEvents(self, eventBitsToRemove)
Reverse the operation of sinkEvents.  See L{UIObject.sinkEvents}.
''', 'Composite': r'''

 
class Composite(Widget)
    
Method resolution order:
Composite
Widget
UIObject
Methods defined here:
__init__(self)
initWidget(self, widget)
onAttach(self)
onDetach(self)
setWidget(self, widget)
Methods inherited from Widget:
getID(self)
Get the id attribute of the associated DOM element.
getLayoutData(self)
getParent(self)
Widgets are kept in a hierarchy, and widgets that have been added to a panel
will have a parent widget that contains them.  This retrieves the containing
widget for this widget.
isAttached(self)
Return whether or not this widget has been attached to the document.
onBrowserEvent(self, event)
onLoad(self, sender)
removeFromParent(self)
Remove ourself from our parent.  The parent widget will call setParent(None) on
us automatically
setID(self, id)
Set the id attribute of the associated DOM element.
setLayoutData(self, layoutData)
setParent(self, parent)
Update the parent attribute.  If the parent is currently attached to the DOM this
assumes we are being attached also and calls onAttach().
Methods inherited from UIObject:
addStyleName(self, style)
Append a style to the element associated with this UIObject.  This is
a CSS class name.  It will be added after any already-assigned CSS class for
the element.
getAbsoluteLeft(self)
getAbsoluteTop(self)
getElement(self)
Get the DOM element associated with the UIObject, if any
getOffsetHeight(self)
getOffsetWidth(self)
getStyleName(self)
getTitle(self)
isVisible(self, element=None)
Determine whether this element is currently visible, by checking the CSS
property 'display'
removeStyleName(self, style)
Remove a style from the element associated with this UIObject.  This is
a CSS class name.
setElement(self, element)
Set the DOM element associated with the UIObject.
setHeight(self, height)
Set the height of the element associated with this UIObject.  The
value should be given as a CSS value, such as 100px, 30%, or 50pi
setPixelSize(self, width, height)
Set the width and height of the element associated with this UIObject
in pixels.  Width and height should be numbers.
setSize(self, width, height)
Set the width and height of the element associated with this UIObject.  The
values should be given as a CSS value, such as 100px, 30%, or 50pi
setStyleName(self, element, style=None, add=True)
When called with a single argument, this replaces all the CSS classes
associated with this UIObject's element with the given parameter.  Otherwise,
this is assumed to be a worker function for addStyleName and removeStyleName.
setTitle(self, title)
setVisible(self, element, visible=None)
Set whether this element is visible or not.  If a single parameter is
given, the self.element is used.  This modifies the CSS property 'display',
which means that an invisible element not only is not drawn, but doesn't
occupy any space on the page.
setWidth(self, width)
Set the width of the element associated with this UIObject.  The
value should be given as a CSS value, such as 100px, 30%, or 50pi
setzIndex(self, index)
sinkEvents(self, eventBitsToAdd)
Request that the given events be delivered to the event handler for this
element.  The event bits passed are added (using inclusive OR) to the events
already "sunk" for the element associated with the UIObject.  The event bits
are a combination of values from class L{Event}.
unsinkEvents(self, eventBitsToRemove)
Reverse the operation of sinkEvents.  See L{UIObject.sinkEvents}.
''', 'Image': r'''

 
class Image(Widget)
    A widget that displays the image at a given URL.
 
 
Method resolution order:
Image
Widget
UIObject
Methods defined here:
__init__(self, url='')
addClickListener(self, listener)
addLoadListener(self, listener)
addMouseListener(self, listener)
getUrl(self)
onBrowserEvent(self, event)
prefetch(self, url)
setUrl(self, url)
Methods inherited from Widget:
getID(self)
Get the id attribute of the associated DOM element.
getLayoutData(self)
getParent(self)
Widgets are kept in a hierarchy, and widgets that have been added to a panel
will have a parent widget that contains them.  This retrieves the containing
widget for this widget.
isAttached(self)
Return whether or not this widget has been attached to the document.
onAttach(self)
Called when this widget has an element, and that element is on the document's
DOM tree, and we have a parent widget.
onDetach(self)
Called when this widget is being removed from the DOM tree of the document.
onLoad(self, sender)
removeFromParent(self)
Remove ourself from our parent.  The parent widget will call setParent(None) on
us automatically
setID(self, id)
Set the id attribute of the associated DOM element.
setLayoutData(self, layoutData)
setParent(self, parent)
Update the parent attribute.  If the parent is currently attached to the DOM this
assumes we are being attached also and calls onAttach().
Methods inherited from UIObject:
addStyleName(self, style)
Append a style to the element associated with this UIObject.  This is
a CSS class name.  It will be added after any already-assigned CSS class for
the element.
getAbsoluteLeft(self)
getAbsoluteTop(self)
getElement(self)
Get the DOM element associated with the UIObject, if any
getOffsetHeight(self)
getOffsetWidth(self)
getStyleName(self)
getTitle(self)
isVisible(self, element=None)
Determine whether this element is currently visible, by checking the CSS
property 'display'
removeStyleName(self, style)
Remove a style from the element associated with this UIObject.  This is
a CSS class name.
setElement(self, element)
Set the DOM element associated with the UIObject.
setHeight(self, height)
Set the height of the element associated with this UIObject.  The
value should be given as a CSS value, such as 100px, 30%, or 50pi
setPixelSize(self, width, height)
Set the width and height of the element associated with this UIObject
in pixels.  Width and height should be numbers.
setSize(self, width, height)
Set the width and height of the element associated with this UIObject.  The
values should be given as a CSS value, such as 100px, 30%, or 50pi
setStyleName(self, element, style=None, add=True)
When called with a single argument, this replaces all the CSS classes
associated with this UIObject's element with the given parameter.  Otherwise,
this is assumed to be a worker function for addStyleName and removeStyleName.
setTitle(self, title)
setVisible(self, element, visible=None)
Set whether this element is visible or not.  If a single parameter is
given, the self.element is used.  This modifies the CSS property 'display',
which means that an invisible element not only is not drawn, but doesn't
occupy any space on the page.
setWidth(self, width)
Set the width of the element associated with this UIObject.  The
value should be given as a CSS value, such as 100px, 30%, or 50pi
setzIndex(self, index)
sinkEvents(self, eventBitsToAdd)
Request that the given events be delivered to the event handler for this
element.  The event bits passed are added (using inclusive OR) to the events
already "sunk" for the element associated with the UIObject.  The event bits
are a combination of values from class L{Event}.
unsinkEvents(self, eventBitsToRemove)
Reverse the operation of sinkEvents.  See L{UIObject.sinkEvents}.
''', 'AbsolutePanel': r'''

 
class AbsolutePanel(ComplexPanel)
    An absolute panel positions all of its children absolutely,
allowing them to overlap.
 
Note that this panel will not automatically resize itself to
allow enough room for its absolutely-positioned children.
It must be explicitly sized in order to make room for them.
 
Once a widget has been added to an absolute panel, the panel
effectively "owns" the positioning of the widget. Any existing
positioning attributes on the widget may be modified by the panel.
 
 
Method resolution order:
AbsolutePanel
ComplexPanel
Panel
Widget
UIObject
Methods defined here:
__init__(self)
add(self, widget, left=None, top=None)
checkWidgetParent(self, widget)
getWidgetLeft(self, widget)
getWidgetTop(self, widget)
setWidgetPosition(self, widget, left, top)
Methods inherited from ComplexPanel:
getChildren(self)
insert(self, widget, container, beforeIndex)
remove(self, widget)
Methods inherited from Panel:
__iter__(self)
adopt(self, widget, container)
clear(self)
# TODO: fix iterator remove()
disown(self, widget)
onAttach(self)
onDetach(self)
Methods inherited from Widget:
getID(self)
Get the id attribute of the associated DOM element.
getLayoutData(self)
getParent(self)
Widgets are kept in a hierarchy, and widgets that have been added to a panel
will have a parent widget that contains them.  This retrieves the containing
widget for this widget.
isAttached(self)
Return whether or not this widget has been attached to the document.
onBrowserEvent(self, event)
onLoad(self, sender)
removeFromParent(self)
Remove ourself from our parent.  The parent widget will call setParent(None) on
us automatically
setID(self, id)
Set the id attribute of the associated DOM element.
setLayoutData(self, layoutData)
setParent(self, parent)
Update the parent attribute.  If the parent is currently attached to the DOM this
assumes we are being attached also and calls onAttach().
Methods inherited from UIObject:
addStyleName(self, style)
Append a style to the element associated with this UIObject.  This is
a CSS class name.  It will be added after any already-assigned CSS class for
the element.
getAbsoluteLeft(self)
getAbsoluteTop(self)
getElement(self)
Get the DOM element associated with the UIObject, if any
getOffsetHeight(self)
getOffsetWidth(self)
getStyleName(self)
getTitle(self)
isVisible(self, element=None)
Determine whether this element is currently visible, by checking the CSS
property 'display'
removeStyleName(self, style)
Remove a style from the element associated with this UIObject.  This is
a CSS class name.
setElement(self, element)
Set the DOM element associated with the UIObject.
setHeight(self, height)
Set the height of the element associated with this UIObject.  The
value should be given as a CSS value, such as 100px, 30%, or 50pi
setPixelSize(self, width, height)
Set the width and height of the element associated with this UIObject
in pixels.  Width and height should be numbers.
setSize(self, width, height)
Set the width and height of the element associated with this UIObject.  The
values should be given as a CSS value, such as 100px, 30%, or 50pi
setStyleName(self, element, style=None, add=True)
When called with a single argument, this replaces all the CSS classes
associated with this UIObject's element with the given parameter.  Otherwise,
this is assumed to be a worker function for addStyleName and removeStyleName.
setTitle(self, title)
setVisible(self, element, visible=None)
Set whether this element is visible or not.  If a single parameter is
given, the self.element is used.  This modifies the CSS property 'display',
which means that an invisible element not only is not drawn, but doesn't
occupy any space on the page.
setWidth(self, width)
Set the width of the element associated with this UIObject.  The
value should be given as a CSS value, such as 100px, 30%, or 50pi
setzIndex(self, index)
sinkEvents(self, eventBitsToAdd)
Request that the given events be delivered to the event handler for this
element.  The event bits passed are added (using inclusive OR) to the events
already "sunk" for the element associated with the UIObject.  The event bits
are a combination of values from class L{Event}.
unsinkEvents(self, eventBitsToRemove)
Reverse the operation of sinkEvents.  See L{UIObject.sinkEvents}.
''', 'UIObject': r'''

 
class UIObject
    UIObject is the base class for user interface objects.
 
  Methods defined here:
addStyleName(self, style)
Append a style to the element associated with this UIObject.  This is
a CSS class name.  It will be added after any already-assigned CSS class for
the element.
getAbsoluteLeft(self)
getAbsoluteTop(self)
getElement(self)
Get the DOM element associated with the UIObject, if any
getOffsetHeight(self)
getOffsetWidth(self)
getStyleName(self)
getTitle(self)
isVisible(self, element=None)
Determine whether this element is currently visible, by checking the CSS
property 'display'
removeStyleName(self, style)
Remove a style from the element associated with this UIObject.  This is
a CSS class name.
setElement(self, element)
Set the DOM element associated with the UIObject.
setHeight(self, height)
Set the height of the element associated with this UIObject.  The
value should be given as a CSS value, such as 100px, 30%, or 50pi
setPixelSize(self, width, height)
Set the width and height of the element associated with this UIObject
in pixels.  Width and height should be numbers.
setSize(self, width, height)
Set the width and height of the element associated with this UIObject.  The
values should be given as a CSS value, such as 100px, 30%, or 50pi
setStyleName(self, element, style=None, add=True)
When called with a single argument, this replaces all the CSS classes
associated with this UIObject's element with the given parameter.  Otherwise,
this is assumed to be a worker function for addStyleName and removeStyleName.
setTitle(self, title)
setVisible(self, element, visible=None)
Set whether this element is visible or not.  If a single parameter is
given, the self.element is used.  This modifies the CSS property 'display',
which means that an invisible element not only is not drawn, but doesn't
occupy any space on the page.
setWidth(self, width)
Set the width of the element associated with this UIObject.  The
value should be given as a CSS value, such as 100px, 30%, or 50pi
setzIndex(self, index)
sinkEvents(self, eventBitsToAdd)
Request that the given events be delivered to the event handler for this
element.  The event bits passed are added (using inclusive OR) to the events
already "sunk" for the element associated with the UIObject.  The event bits
are a combination of values from class L{Event}.
unsinkEvents(self, eventBitsToRemove)
Reverse the operation of sinkEvents.  See L{UIObject.sinkEvents}.
''', 'PasswordTextBox': r'''

 
class PasswordTextBox(TextBoxBase)
    PasswordTextBox is a text box that visually masks its input to
prevent eavesdropping.
 
 
Method resolution order:
PasswordTextBox
TextBoxBase
FocusWidget
Widget
UIObject
Methods defined here:
__init__(self)
Methods inherited from TextBoxBase:
addChangeListener(self, listener)
addClickListener(self, listener)
addKeyboardListener(self, listener)
cancelKey(self)
getCursorPos(self)
getName(self)
getSelectedText(self)
getSelectionLength(self)
getText(self)
onBrowserEvent(self, event)
# BUG: keyboard & click events already fired in FocusWidget.onBrowserEvent
removeChangeListener(self, listener)
removeClickListener(self, listener)
removeKeyboardListener(self, listener)
selectAll(self)
setCursorPos(self, pos)
setKey(self, key)
setName(self, name)
setSelectionRange(self, pos, length)
setText(self, text)
setTextAlignment(self, align)
Data and other attributes inherited from TextBoxBase:
ALIGN_CENTER = 'center'
ALIGN_JUSTIFY = 'justify'
ALIGN_LEFT = 'left'
ALIGN_RIGHT = 'right'
Methods inherited from FocusWidget:
addFocusListener(self, listener)
getTabIndex(self)
isEnabled(self)
removeFocusListener(self, listener)
setAccessKey(self, key)
setEnabled(self, enabled)
setFocus(self, focused)
setTabIndex(self, index)
Methods inherited from Widget:
getID(self)
Get the id attribute of the associated DOM element.
getLayoutData(self)
getParent(self)
Widgets are kept in a hierarchy, and widgets that have been added to a panel
will have a parent widget that contains them.  This retrieves the containing
widget for this widget.
isAttached(self)
Return whether or not this widget has been attached to the document.
onAttach(self)
Called when this widget has an element, and that element is on the document's
DOM tree, and we have a parent widget.
onDetach(self)
Called when this widget is being removed from the DOM tree of the document.
onLoad(self, sender)
removeFromParent(self)
Remove ourself from our parent.  The parent widget will call setParent(None) on
us automatically
setID(self, id)
Set the id attribute of the associated DOM element.
setLayoutData(self, layoutData)
setParent(self, parent)
Update the parent attribute.  If the parent is currently attached to the DOM this
assumes we are being attached also and calls onAttach().
Methods inherited from UIObject:
addStyleName(self, style)
Append a style to the element associated with this UIObject.  This is
a CSS class name.  It will be added after any already-assigned CSS class for
the element.
getAbsoluteLeft(self)
getAbsoluteTop(self)
getElement(self)
Get the DOM element associated with the UIObject, if any
getOffsetHeight(self)
getOffsetWidth(self)
getStyleName(self)
getTitle(self)
isVisible(self, element=None)
Determine whether this element is currently visible, by checking the CSS
property 'display'
removeStyleName(self, style)
Remove a style from the element associated with this UIObject.  This is
a CSS class name.
setElement(self, element)
Set the DOM element associated with the UIObject.
setHeight(self, height)
Set the height of the element associated with this UIObject.  The
value should be given as a CSS value, such as 100px, 30%, or 50pi
setPixelSize(self, width, height)
Set the width and height of the element associated with this UIObject
in pixels.  Width and height should be numbers.
setSize(self, width, height)
Set the width and height of the element associated with this UIObject.  The
values should be given as a CSS value, such as 100px, 30%, or 50pi
setStyleName(self, element, style=None, add=True)
When called with a single argument, this replaces all the CSS classes
associated with this UIObject's element with the given parameter.  Otherwise,
this is assumed to be a worker function for addStyleName and removeStyleName.
setTitle(self, title)
setVisible(self, element, visible=None)
Set whether this element is visible or not.  If a single parameter is
given, the self.element is used.  This modifies the CSS property 'display',
which means that an invisible element not only is not drawn, but doesn't
occupy any space on the page.
setWidth(self, width)
Set the width of the element associated with this UIObject.  The
value should be given as a CSS value, such as 100px, 30%, or 50pi
setzIndex(self, index)
sinkEvents(self, eventBitsToAdd)
Request that the given events be delivered to the event handler for this
element.  The event bits passed are added (using inclusive OR) to the events
already "sunk" for the element associated with the UIObject.  The event bits
are a combination of values from class L{Event}.
unsinkEvents(self, eventBitsToRemove)
Reverse the operation of sinkEvents.  See L{UIObject.sinkEvents}.
''', 'HTML': r'''

 
class HTML(Label)
    A widget that can contain arbitrary HTML.
 
If you only need a simple label (text, but not HTML), then the
Label widget is more appropriate, as it disallows the use of HTML,
which can lead to potential security issues if not used properly.
 
 
Method resolution order:
HTML
Label
Widget
UIObject
Methods defined here:
__init__(self, html=None, wordWrap=True)
getHTML(self)
setHTML(self, html)
Methods inherited from Label:
addClickListener(self, listener)
addMouseListener(self, listener)
getHorizontalAlignment(self)
getText(self)
getWordWrap(self)
onBrowserEvent(self, event)
removeClickListener(self, listener)
removeMouseListener(self, listener)
setHorizontalAlignment(self, align)
setText(self, text)
setWordWrap(self, wrap)
Methods inherited from Widget:
getID(self)
Get the id attribute of the associated DOM element.
getLayoutData(self)
getParent(self)
Widgets are kept in a hierarchy, and widgets that have been added to a panel
will have a parent widget that contains them.  This retrieves the containing
widget for this widget.
isAttached(self)
Return whether or not this widget has been attached to the document.
onAttach(self)
Called when this widget has an element, and that element is on the document's
DOM tree, and we have a parent widget.
onDetach(self)
Called when this widget is being removed from the DOM tree of the document.
onLoad(self, sender)
removeFromParent(self)
Remove ourself from our parent.  The parent widget will call setParent(None) on
us automatically
setID(self, id)
Set the id attribute of the associated DOM element.
setLayoutData(self, layoutData)
setParent(self, parent)
Update the parent attribute.  If the parent is currently attached to the DOM this
assumes we are being attached also and calls onAttach().
Methods inherited from UIObject:
addStyleName(self, style)
Append a style to the element associated with this UIObject.  This is
a CSS class name.  It will be added after any already-assigned CSS class for
the element.
getAbsoluteLeft(self)
getAbsoluteTop(self)
getElement(self)
Get the DOM element associated with the UIObject, if any
getOffsetHeight(self)
getOffsetWidth(self)
getStyleName(self)
getTitle(self)
isVisible(self, element=None)
Determine whether this element is currently visible, by checking the CSS
property 'display'
removeStyleName(self, style)
Remove a style from the element associated with this UIObject.  This is
a CSS class name.
setElement(self, element)
Set the DOM element associated with the UIObject.
setHeight(self, height)
Set the height of the element associated with this UIObject.  The
value should be given as a CSS value, such as 100px, 30%, or 50pi
setPixelSize(self, width, height)
Set the width and height of the element associated with this UIObject
in pixels.  Width and height should be numbers.
setSize(self, width, height)
Set the width and height of the element associated with this UIObject.  The
values should be given as a CSS value, such as 100px, 30%, or 50pi
setStyleName(self, element, style=None, add=True)
When called with a single argument, this replaces all the CSS classes
associated with this UIObject's element with the given parameter.  Otherwise,
this is assumed to be a worker function for addStyleName and removeStyleName.
setTitle(self, title)
setVisible(self, element, visible=None)
Set whether this element is visible or not.  If a single parameter is
given, the self.element is used.  This modifies the CSS property 'display',
which means that an invisible element not only is not drawn, but doesn't
occupy any space on the page.
setWidth(self, width)
Set the width of the element associated with this UIObject.  The
value should be given as a CSS value, such as 100px, 30%, or 50pi
setzIndex(self, index)
sinkEvents(self, eventBitsToAdd)
Request that the given events be delivered to the event handler for this
element.  The event bits passed are added (using inclusive OR) to the events
already "sunk" for the element associated with the UIObject.  The event bits
are a combination of values from class L{Event}.
unsinkEvents(self, eventBitsToRemove)
Reverse the operation of sinkEvents.  See L{UIObject.sinkEvents}.
''', 'Grid': r'''

 
class Grid(HTMLTable)
    The Grid Widget is a type of HTMLTable where all of the cells
are pre-loaded at the very least with some blank content.
 
 
Method resolution order:
Grid
HTMLTable
Panel
Widget
UIObject
Methods defined here:
__init__(self, rows=0, columns=0)
addRows(self, table, numRows, columns)
clearCell(self, row, column)
createCell(self)
getCellCount(self, row)
getColumnCount(self)
getRowCount(self)
prepareCell(self, row, column)
prepareRow(self, row)
resize(self, rows, columns)
resizeColumns(self, columns)
resizeRows(self, rows)
Methods inherited from HTMLTable:
__iter__(self)
addTableListener(self, listener)
checkCellBounds(self, row, column)
checkRowBounds(self, row)
cleanCell(self, row, column)
clear(self)
computeKey(self, row, column)
computeKeyForElement(self, widgetElement)
getBodyElement(self)
getCellFormatter(self)
getCellPadding(self)
getCellSpacing(self)
getDOMCellCount(self, element, row=None)
# also callable as getDOMCellCount(row)
getDOMCellCountImpl(self, element, row)
getDOMRowCount(self, element=None)
# also callable as getDOMRowCount(element)
getDOMRowCountImpl(self, element)
getEventTargetCell(self, event)
getHTML(self, row, column)
getRowFormatter(self)
getText(self, row, column)
getWidget(self, row, column=None)
# also callable as getWidget(widgetElement)
insertCell(self, row, column)
insertCells(self, row, column, count)
insertRow(self, beforeRow)
internalClearCell(self, td)
isCellPresent(self, row, column)
onBrowserEvent(self, event)
remove(self, widget)
removeCell(self, row, column)
removeRow(self, row)
removeTableListener(self, listener)
removeWidget(self, widget)
setBorderWidth(self, width)
setCellFormatter(self, cellFormatter)
setCellPadding(self, padding)
setCellSpacing(self, spacing)
setHTML(self, row, column, html)
setRowFormatter(self, rowFormatter)
setText(self, row, column, text)
setWidget(self, row, column, widget)
Methods inherited from Panel:
add(self)
adopt(self, widget, container)
disown(self, widget)
onAttach(self)
onDetach(self)
Methods inherited from Widget:
getID(self)
Get the id attribute of the associated DOM element.
getLayoutData(self)
getParent(self)
Widgets are kept in a hierarchy, and widgets that have been added to a panel
will have a parent widget that contains them.  This retrieves the containing
widget for this widget.
isAttached(self)
Return whether or not this widget has been attached to the document.
onLoad(self, sender)
removeFromParent(self)
Remove ourself from our parent.  The parent widget will call setParent(None) on
us automatically
setID(self, id)
Set the id attribute of the associated DOM element.
setLayoutData(self, layoutData)
setParent(self, parent)
Update the parent attribute.  If the parent is currently attached to the DOM this
assumes we are being attached also and calls onAttach().
Methods inherited from UIObject:
addStyleName(self, style)
Append a style to the element associated with this UIObject.  This is
a CSS class name.  It will be added after any already-assigned CSS class for
the element.
getAbsoluteLeft(self)
getAbsoluteTop(self)
getElement(self)
Get the DOM element associated with the UIObject, if any
getOffsetHeight(self)
getOffsetWidth(self)
getStyleName(self)
getTitle(self)
isVisible(self, element=None)
Determine whether this element is currently visible, by checking the CSS
property 'display'
removeStyleName(self, style)
Remove a style from the element associated with this UIObject.  This is
a CSS class name.
setElement(self, element)
Set the DOM element associated with the UIObject.
setHeight(self, height)
Set the height of the element associated with this UIObject.  The
value should be given as a CSS value, such as 100px, 30%, or 50pi
setPixelSize(self, width, height)
Set the width and height of the element associated with this UIObject
in pixels.  Width and height should be numbers.
setSize(self, width, height)
Set the width and height of the element associated with this UIObject.  The
values should be given as a CSS value, such as 100px, 30%, or 50pi
setStyleName(self, element, style=None, add=True)
When called with a single argument, this replaces all the CSS classes
associated with this UIObject's element with the given parameter.  Otherwise,
this is assumed to be a worker function for addStyleName and removeStyleName.
setTitle(self, title)
setVisible(self, element, visible=None)
Set whether this element is visible or not.  If a single parameter is
given, the self.element is used.  This modifies the CSS property 'display',
which means that an invisible element not only is not drawn, but doesn't
occupy any space on the page.
setWidth(self, width)
Set the width of the element associated with this UIObject.  The
value should be given as a CSS value, such as 100px, 30%, or 50pi
setzIndex(self, index)
sinkEvents(self, eventBitsToAdd)
Request that the given events be delivered to the event handler for this
element.  The event bits passed are added (using inclusive OR) to the events
already "sunk" for the element associated with the UIObject.  The event bits
are a combination of values from class L{Event}.
unsinkEvents(self, eventBitsToRemove)
Reverse the operation of sinkEvents.  See L{UIObject.sinkEvents}.
''', 'FocusWidget': r'''

 
class FocusWidget(Widget)
    FocusWidget is the base widget for objects which take user-input,
such as Buttons, ListBoxes and Text input widgets.  It is only
necessary to instantiate from this class if you intend to make
your own custom input widget.
 
 
Method resolution order:
FocusWidget
Widget
UIObject
Methods defined here:
__init__(self, element)
addClickListener(self, listener)
addFocusListener(self, listener)
addKeyboardListener(self, listener)
getTabIndex(self)
isEnabled(self)
onBrowserEvent(self, event)
removeClickListener(self, listener)
removeFocusListener(self, listener)
removeKeyboardListener(self, listener)
setAccessKey(self, key)
setEnabled(self, enabled)
setFocus(self, focused)
setTabIndex(self, index)
Methods inherited from Widget:
getID(self)
Get the id attribute of the associated DOM element.
getLayoutData(self)
getParent(self)
Widgets are kept in a hierarchy, and widgets that have been added to a panel
will have a parent widget that contains them.  This retrieves the containing
widget for this widget.
isAttached(self)
Return whether or not this widget has been attached to the document.
onAttach(self)
Called when this widget has an element, and that element is on the document's
DOM tree, and we have a parent widget.
onDetach(self)
Called when this widget is being removed from the DOM tree of the document.
onLoad(self, sender)
removeFromParent(self)
Remove ourself from our parent.  The parent widget will call setParent(None) on
us automatically
setID(self, id)
Set the id attribute of the associated DOM element.
setLayoutData(self, layoutData)
setParent(self, parent)
Update the parent attribute.  If the parent is currently attached to the DOM this
assumes we are being attached also and calls onAttach().
Methods inherited from UIObject:
addStyleName(self, style)
Append a style to the element associated with this UIObject.  This is
a CSS class name.  It will be added after any already-assigned CSS class for
the element.
getAbsoluteLeft(self)
getAbsoluteTop(self)
getElement(self)
Get the DOM element associated with the UIObject, if any
getOffsetHeight(self)
getOffsetWidth(self)
getStyleName(self)
getTitle(self)
isVisible(self, element=None)
Determine whether this element is currently visible, by checking the CSS
property 'display'
removeStyleName(self, style)
Remove a style from the element associated with this UIObject.  This is
a CSS class name.
setElement(self, element)
Set the DOM element associated with the UIObject.
setHeight(self, height)
Set the height of the element associated with this UIObject.  The
value should be given as a CSS value, such as 100px, 30%, or 50pi
setPixelSize(self, width, height)
Set the width and height of the element associated with this UIObject
in pixels.  Width and height should be numbers.
setSize(self, width, height)
Set the width and height of the element associated with this UIObject.  The
values should be given as a CSS value, such as 100px, 30%, or 50pi
setStyleName(self, element, style=None, add=True)
When called with a single argument, this replaces all the CSS classes
associated with this UIObject's element with the given parameter.  Otherwise,
this is assumed to be a worker function for addStyleName and removeStyleName.
setTitle(self, title)
setVisible(self, element, visible=None)
Set whether this element is visible or not.  If a single parameter is
given, the self.element is used.  This modifies the CSS property 'display',
which means that an invisible element not only is not drawn, but doesn't
occupy any space on the page.
setWidth(self, width)
Set the width of the element associated with this UIObject.  The
value should be given as a CSS value, such as 100px, 30%, or 50pi
setzIndex(self, index)
sinkEvents(self, eventBitsToAdd)
Request that the given events be delivered to the event handler for this
element.  The event bits passed are added (using inclusive OR) to the events
already "sunk" for the element associated with the UIObject.  The event bits
are a combination of values from class L{Event}.
unsinkEvents(self, eventBitsToRemove)
Reverse the operation of sinkEvents.  See L{UIObject.sinkEvents}.
''', 'FocusPanel': r'''

 
class FocusPanel(SimplePanel)
    A simple panel that makes its contents focusable,
and adds the ability to catch mouse and keyboard events.
 
 
Method resolution order:
FocusPanel
SimplePanel
Panel
Widget
UIObject
Methods defined here:
__init__(self, child=None)
addClickListener(self, listener)
addFocusListener(self, listener)
addKeyboardListener(self, listener)
addMouseListener(self, listener)
getTabIndex(self)
onBrowserEvent(self, event)
removeClickListener(self, listener)
removeFocusListener(self, listener)
removeKeyboardListener(self, listener)
removeMouseListener(self, listener)
setAccessKey(self, key)
setFocus(self, focused)
setTabIndex(self, index)
Methods inherited from SimplePanel:
add(self, widget)
getContainerElement(self)
getWidget(self)
remove(self, widget)
setWidget(self, widget)
Methods inherited from Panel:
__iter__(self)
adopt(self, widget, container)
clear(self)
# TODO: fix iterator remove()
disown(self, widget)
onAttach(self)
onDetach(self)
Methods inherited from Widget:
getID(self)
Get the id attribute of the associated DOM element.
getLayoutData(self)
getParent(self)
Widgets are kept in a hierarchy, and widgets that have been added to a panel
will have a parent widget that contains them.  This retrieves the containing
widget for this widget.
isAttached(self)
Return whether or not this widget has been attached to the document.
onLoad(self, sender)
removeFromParent(self)
Remove ourself from our parent.  The parent widget will call setParent(None) on
us automatically
setID(self, id)
Set the id attribute of the associated DOM element.
setLayoutData(self, layoutData)
setParent(self, parent)
Update the parent attribute.  If the parent is currently attached to the DOM this
assumes we are being attached also and calls onAttach().
Methods inherited from UIObject:
addStyleName(self, style)
Append a style to the element associated with this UIObject.  This is
a CSS class name.  It will be added after any already-assigned CSS class for
the element.
getAbsoluteLeft(self)
getAbsoluteTop(self)
getElement(self)
Get the DOM element associated with the UIObject, if any
getOffsetHeight(self)
getOffsetWidth(self)
getStyleName(self)
getTitle(self)
isVisible(self, element=None)
Determine whether this element is currently visible, by checking the CSS
property 'display'
removeStyleName(self, style)
Remove a style from the element associated with this UIObject.  This is
a CSS class name.
setElement(self, element)
Set the DOM element associated with the UIObject.
setHeight(self, height)
Set the height of the element associated with this UIObject.  The
value should be given as a CSS value, such as 100px, 30%, or 50pi
setPixelSize(self, width, height)
Set the width and height of the element associated with this UIObject
in pixels.  Width and height should be numbers.
setSize(self, width, height)
Set the width and height of the element associated with this UIObject.  The
values should be given as a CSS value, such as 100px, 30%, or 50pi
setStyleName(self, element, style=None, add=True)
When called with a single argument, this replaces all the CSS classes
associated with this UIObject's element with the given parameter.  Otherwise,
this is assumed to be a worker function for addStyleName and removeStyleName.
setTitle(self, title)
setVisible(self, element, visible=None)
Set whether this element is visible or not.  If a single parameter is
given, the self.element is used.  This modifies the CSS property 'display',
which means that an invisible element not only is not drawn, but doesn't
occupy any space on the page.
setWidth(self, width)
Set the width of the element associated with this UIObject.  The
value should be given as a CSS value, such as 100px, 30%, or 50pi
setzIndex(self, index)
sinkEvents(self, eventBitsToAdd)
Request that the given events be delivered to the event handler for this
element.  The event bits passed are added (using inclusive OR) to the events
already "sunk" for the element associated with the UIObject.  The event bits
are a combination of values from class L{Event}.
unsinkEvents(self, eventBitsToRemove)
Reverse the operation of sinkEvents.  See L{UIObject.sinkEvents}.
''', 'HasHorizontalAlignment': r'''

 
class HasHorizontalAlignment
     Data and other attributes defined here:
ALIGN_CENTER = 'center'
ALIGN_LEFT = 'left'
ALIGN_RIGHT = 'right'
''', 'DeckPanel': r'''

 
class DeckPanel(ComplexPanel)
    A panel that displays all of its child widgets in a 'deck',
where only one can be visible at a time. It is used by TabPanel.
 
Once a widget has been added to a DeckPanel, its visibility, width,
and height attributes will be manipulated. When the widget is
removed from the DeckPanel, it will be visible, and its width and
height attributes will be cleared.
 
 
Method resolution order:
DeckPanel
ComplexPanel
Panel
Widget
UIObject
Methods defined here:
__init__(self)
add(self, widget)
checkIndex(self, index)
getVisibleWidget(self)
getWidget(self, index)
getWidgetCount(self)
getWidgetIndex(self, child)
insert(self, widget, beforeIndex)
remove(self, widget)
showWidget(self, index)
Methods inherited from ComplexPanel:
getChildren(self)
Methods inherited from Panel:
__iter__(self)
adopt(self, widget, container)
clear(self)
# TODO: fix iterator remove()
disown(self, widget)
onAttach(self)
onDetach(self)
Methods inherited from Widget:
getID(self)
Get the id attribute of the associated DOM element.
getLayoutData(self)
getParent(self)
Widgets are kept in a hierarchy, and widgets that have been added to a panel
will have a parent widget that contains them.  This retrieves the containing
widget for this widget.
isAttached(self)
Return whether or not this widget has been attached to the document.
onBrowserEvent(self, event)
onLoad(self, sender)
removeFromParent(self)
Remove ourself from our parent.  The parent widget will call setParent(None) on
us automatically
setID(self, id)
Set the id attribute of the associated DOM element.
setLayoutData(self, layoutData)
setParent(self, parent)
Update the parent attribute.  If the parent is currently attached to the DOM this
assumes we are being attached also and calls onAttach().
Methods inherited from UIObject:
addStyleName(self, style)
Append a style to the element associated with this UIObject.  This is
a CSS class name.  It will be added after any already-assigned CSS class for
the element.
getAbsoluteLeft(self)
getAbsoluteTop(self)
getElement(self)
Get the DOM element associated with the UIObject, if any
getOffsetHeight(self)
getOffsetWidth(self)
getStyleName(self)
getTitle(self)
isVisible(self, element=None)
Determine whether this element is currently visible, by checking the CSS
property 'display'
removeStyleName(self, style)
Remove a style from the element associated with this UIObject.  This is
a CSS class name.
setElement(self, element)
Set the DOM element associated with the UIObject.
setHeight(self, height)
Set the height of the element associated with this UIObject.  The
value should be given as a CSS value, such as 100px, 30%, or 50pi
setPixelSize(self, width, height)
Set the width and height of the element associated with this UIObject
in pixels.  Width and height should be numbers.
setSize(self, width, height)
Set the width and height of the element associated with this UIObject.  The
values should be given as a CSS value, such as 100px, 30%, or 50pi
setStyleName(self, element, style=None, add=True)
When called with a single argument, this replaces all the CSS classes
associated with this UIObject's element with the given parameter.  Otherwise,
this is assumed to be a worker function for addStyleName and removeStyleName.
setTitle(self, title)
setVisible(self, element, visible=None)
Set whether this element is visible or not.  If a single parameter is
given, the self.element is used.  This modifies the CSS property 'display',
which means that an invisible element not only is not drawn, but doesn't
occupy any space on the page.
setWidth(self, width)
Set the width of the element associated with this UIObject.  The
value should be given as a CSS value, such as 100px, 30%, or 50pi
setzIndex(self, index)
sinkEvents(self, eventBitsToAdd)
Request that the given events be delivered to the event handler for this
element.  The event bits passed are added (using inclusive OR) to the events
already "sunk" for the element associated with the UIObject.  The event bits
are a combination of values from class L{Event}.
unsinkEvents(self, eventBitsToRemove)
Reverse the operation of sinkEvents.  See L{UIObject.sinkEvents}.
''', 'Panel': r'''

 
class Panel(Widget)
    The basic 'Panel' widget class which can contain other widgets.
Panel is a base class from which other Panel classes are derived:
you will not need to instantiate a Panel class, but if you create
your own Panel widgets, derive them from this class.
 
 
Method resolution order:
Panel
Widget
UIObject
Methods defined here:
__init__(self)
__iter__(self)
add(self)
adopt(self, widget, container)
clear(self)
# TODO: fix iterator remove()
disown(self, widget)
onAttach(self)
onDetach(self)
remove(self, widget)
Methods inherited from Widget:
getID(self)
Get the id attribute of the associated DOM element.
getLayoutData(self)
getParent(self)
Widgets are kept in a hierarchy, and widgets that have been added to a panel
will have a parent widget that contains them.  This retrieves the containing
widget for this widget.
isAttached(self)
Return whether or not this widget has been attached to the document.
onBrowserEvent(self, event)
onLoad(self, sender)
removeFromParent(self)
Remove ourself from our parent.  The parent widget will call setParent(None) on
us automatically
setID(self, id)
Set the id attribute of the associated DOM element.
setLayoutData(self, layoutData)
setParent(self, parent)
Update the parent attribute.  If the parent is currently attached to the DOM this
assumes we are being attached also and calls onAttach().
Methods inherited from UIObject:
addStyleName(self, style)
Append a style to the element associated with this UIObject.  This is
a CSS class name.  It will be added after any already-assigned CSS class for
the element.
getAbsoluteLeft(self)
getAbsoluteTop(self)
getElement(self)
Get the DOM element associated with the UIObject, if any
getOffsetHeight(self)
getOffsetWidth(self)
getStyleName(self)
getTitle(self)
isVisible(self, element=None)
Determine whether this element is currently visible, by checking the CSS
property 'display'
removeStyleName(self, style)
Remove a style from the element associated with this UIObject.  This is
a CSS class name.
setElement(self, element)
Set the DOM element associated with the UIObject.
setHeight(self, height)
Set the height of the element associated with this UIObject.  The
value should be given as a CSS value, such as 100px, 30%, or 50pi
setPixelSize(self, width, height)
Set the width and height of the element associated with this UIObject
in pixels.  Width and height should be numbers.
setSize(self, width, height)
Set the width and height of the element associated with this UIObject.  The
values should be given as a CSS value, such as 100px, 30%, or 50pi
setStyleName(self, element, style=None, add=True)
When called with a single argument, this replaces all the CSS classes
associated with this UIObject's element with the given parameter.  Otherwise,
this is assumed to be a worker function for addStyleName and removeStyleName.
setTitle(self, title)
setVisible(self, element, visible=None)
Set whether this element is visible or not.  If a single parameter is
given, the self.element is used.  This modifies the CSS property 'display',
which means that an invisible element not only is not drawn, but doesn't
occupy any space on the page.
setWidth(self, width)
Set the width of the element associated with this UIObject.  The
value should be given as a CSS value, such as 100px, 30%, or 50pi
setzIndex(self, index)
sinkEvents(self, eventBitsToAdd)
Request that the given events be delivered to the event handler for this
element.  The event bits passed are added (using inclusive OR) to the events
already "sunk" for the element associated with the UIObject.  The event bits
are a combination of values from class L{Event}.
unsinkEvents(self, eventBitsToRemove)
Reverse the operation of sinkEvents.  See L{UIObject.sinkEvents}.
''', 'FileUpload': r'''

 
class FileUpload(Widget)
    A widget that wraps the HTML <input type='file'> element.
This widget must be used with FormPanel if it is to be submitted
to a server.
 
 
Method resolution order:
FileUpload
Widget
UIObject
Methods defined here:
__init__(self)
getFilename(self)
getName(self)
setName(self, name)
Methods inherited from Widget:
getID(self)
Get the id attribute of the associated DOM element.
getLayoutData(self)
getParent(self)
Widgets are kept in a hierarchy, and widgets that have been added to a panel
will have a parent widget that contains them.  This retrieves the containing
widget for this widget.
isAttached(self)
Return whether or not this widget has been attached to the document.
onAttach(self)
Called when this widget has an element, and that element is on the document's
DOM tree, and we have a parent widget.
onBrowserEvent(self, event)
onDetach(self)
Called when this widget is being removed from the DOM tree of the document.
onLoad(self, sender)
removeFromParent(self)
Remove ourself from our parent.  The parent widget will call setParent(None) on
us automatically
setID(self, id)
Set the id attribute of the associated DOM element.
setLayoutData(self, layoutData)
setParent(self, parent)
Update the parent attribute.  If the parent is currently attached to the DOM this
assumes we are being attached also and calls onAttach().
Methods inherited from UIObject:
addStyleName(self, style)
Append a style to the element associated with this UIObject.  This is
a CSS class name.  It will be added after any already-assigned CSS class for
the element.
getAbsoluteLeft(self)
getAbsoluteTop(self)
getElement(self)
Get the DOM element associated with the UIObject, if any
getOffsetHeight(self)
getOffsetWidth(self)
getStyleName(self)
getTitle(self)
isVisible(self, element=None)
Determine whether this element is currently visible, by checking the CSS
property 'display'
removeStyleName(self, style)
Remove a style from the element associated with this UIObject.  This is
a CSS class name.
setElement(self, element)
Set the DOM element associated with the UIObject.
setHeight(self, height)
Set the height of the element associated with this UIObject.  The
value should be given as a CSS value, such as 100px, 30%, or 50pi
setPixelSize(self, width, height)
Set the width and height of the element associated with this UIObject
in pixels.  Width and height should be numbers.
setSize(self, width, height)
Set the width and height of the element associated with this UIObject.  The
values should be given as a CSS value, such as 100px, 30%, or 50pi
setStyleName(self, element, style=None, add=True)
When called with a single argument, this replaces all the CSS classes
associated with this UIObject's element with the given parameter.  Otherwise,
this is assumed to be a worker function for addStyleName and removeStyleName.
setTitle(self, title)
setVisible(self, element, visible=None)
Set whether this element is visible or not.  If a single parameter is
given, the self.element is used.  This modifies the CSS property 'display',
which means that an invisible element not only is not drawn, but doesn't
occupy any space on the page.
setWidth(self, width)
Set the width of the element associated with this UIObject.  The
value should be given as a CSS value, such as 100px, 30%, or 50pi
setzIndex(self, index)
sinkEvents(self, eventBitsToAdd)
Request that the given events be delivered to the event handler for this
element.  The event bits passed are added (using inclusive OR) to the events
already "sunk" for the element associated with the UIObject.  The event bits
are a combination of values from class L{Event}.
unsinkEvents(self, eventBitsToRemove)
Reverse the operation of sinkEvents.  See L{UIObject.sinkEvents}.
''', 'SimplePanel': r'''

 
class SimplePanel(Panel)
    A panel which contains a single widget.  Useful if you have an
area where you'd like to be able to replace the widget with another,
or if you need to wrap something in a DIV.
 
 
Method resolution order:
SimplePanel
Panel
Widget
UIObject
Methods defined here:
__init__(self, element=None)
add(self, widget)
getContainerElement(self)
getWidget(self)
remove(self, widget)
setWidget(self, widget)
Methods inherited from Panel:
__iter__(self)
adopt(self, widget, container)
clear(self)
# TODO: fix iterator remove()
disown(self, widget)
onAttach(self)
onDetach(self)
Methods inherited from Widget:
getID(self)
Get the id attribute of the associated DOM element.
getLayoutData(self)
getParent(self)
Widgets are kept in a hierarchy, and widgets that have been added to a panel
will have a parent widget that contains them.  This retrieves the containing
widget for this widget.
isAttached(self)
Return whether or not this widget has been attached to the document.
onBrowserEvent(self, event)
onLoad(self, sender)
removeFromParent(self)
Remove ourself from our parent.  The parent widget will call setParent(None) on
us automatically
setID(self, id)
Set the id attribute of the associated DOM element.
setLayoutData(self, layoutData)
setParent(self, parent)
Update the parent attribute.  If the parent is currently attached to the DOM this
assumes we are being attached also and calls onAttach().
Methods inherited from UIObject:
addStyleName(self, style)
Append a style to the element associated with this UIObject.  This is
a CSS class name.  It will be added after any already-assigned CSS class for
the element.
getAbsoluteLeft(self)
getAbsoluteTop(self)
getElement(self)
Get the DOM element associated with the UIObject, if any
getOffsetHeight(self)
getOffsetWidth(self)
getStyleName(self)
getTitle(self)
isVisible(self, element=None)
Determine whether this element is currently visible, by checking the CSS
property 'display'
removeStyleName(self, style)
Remove a style from the element associated with this UIObject.  This is
a CSS class name.
setElement(self, element)
Set the DOM element associated with the UIObject.
setHeight(self, height)
Set the height of the element associated with this UIObject.  The
value should be given as a CSS value, such as 100px, 30%, or 50pi
setPixelSize(self, width, height)
Set the width and height of the element associated with this UIObject
in pixels.  Width and height should be numbers.
setSize(self, width, height)
Set the width and height of the element associated with this UIObject.  The
values should be given as a CSS value, such as 100px, 30%, or 50pi
setStyleName(self, element, style=None, add=True)
When called with a single argument, this replaces all the CSS classes
associated with this UIObject's element with the given parameter.  Otherwise,
this is assumed to be a worker function for addStyleName and removeStyleName.
setTitle(self, title)
setVisible(self, element, visible=None)
Set whether this element is visible or not.  If a single parameter is
given, the self.element is used.  This modifies the CSS property 'display',
which means that an invisible element not only is not drawn, but doesn't
occupy any space on the page.
setWidth(self, width)
Set the width of the element associated with this UIObject.  The
value should be given as a CSS value, such as 100px, 30%, or 50pi
setzIndex(self, index)
sinkEvents(self, eventBitsToAdd)
Request that the given events be delivered to the event handler for this
element.  The event bits passed are added (using inclusive OR) to the events
already "sunk" for the element associated with the UIObject.  The event bits
are a combination of values from class L{Event}.
unsinkEvents(self, eventBitsToRemove)
Reverse the operation of sinkEvents.  See L{UIObject.sinkEvents}.
''', 'VerticalPanel': r'''

 
class VerticalPanel(CellPanel)
    A panel that lays all of its widgets out in a single vertical column.
 
 
Method resolution order:
VerticalPanel
CellPanel
ComplexPanel
Panel
Widget
UIObject
Methods defined here:
__init__(self)
add(self, widget)
getHorizontalAlignment(self)
getVerticalAlignment(self)
getWidget(self, index)
getWidgetCount(self)
getWidgetIndex(self, child)
insert(self, widget, beforeIndex)
remove(self, widget)
setHorizontalAlignment(self, align)
setVerticalAlignment(self, align)
setWidget(self, index, widget)
Replace the widget at the given index with a new one
Methods inherited from CellPanel:
getBody(self)
getSpacing(self)
getTable(self)
getWidgetTd(self, widget)
setBorderWidth(self, width)
setCellHeight(self, widget, height)
setCellHorizontalAlignment(self, widget, align)
setCellVerticalAlignment(self, widget, align)
setCellWidth(self, widget, width)
setSpacing(self, spacing)
Methods inherited from ComplexPanel:
getChildren(self)
Methods inherited from Panel:
__iter__(self)
adopt(self, widget, container)
clear(self)
# TODO: fix iterator remove()
disown(self, widget)
onAttach(self)
onDetach(self)
Methods inherited from Widget:
getID(self)
Get the id attribute of the associated DOM element.
getLayoutData(self)
getParent(self)
Widgets are kept in a hierarchy, and widgets that have been added to a panel
will have a parent widget that contains them.  This retrieves the containing
widget for this widget.
isAttached(self)
Return whether or not this widget has been attached to the document.
onBrowserEvent(self, event)
onLoad(self, sender)
removeFromParent(self)
Remove ourself from our parent.  The parent widget will call setParent(None) on
us automatically
setID(self, id)
Set the id attribute of the associated DOM element.
setLayoutData(self, layoutData)
setParent(self, parent)
Update the parent attribute.  If the parent is currently attached to the DOM this
assumes we are being attached also and calls onAttach().
Methods inherited from UIObject:
addStyleName(self, style)
Append a style to the element associated with this UIObject.  This is
a CSS class name.  It will be added after any already-assigned CSS class for
the element.
getAbsoluteLeft(self)
getAbsoluteTop(self)
getElement(self)
Get the DOM element associated with the UIObject, if any
getOffsetHeight(self)
getOffsetWidth(self)
getStyleName(self)
getTitle(self)
isVisible(self, element=None)
Determine whether this element is currently visible, by checking the CSS
property 'display'
removeStyleName(self, style)
Remove a style from the element associated with this UIObject.  This is
a CSS class name.
setElement(self, element)
Set the DOM element associated with the UIObject.
setHeight(self, height)
Set the height of the element associated with this UIObject.  The
value should be given as a CSS value, such as 100px, 30%, or 50pi
setPixelSize(self, width, height)
Set the width and height of the element associated with this UIObject
in pixels.  Width and height should be numbers.
setSize(self, width, height)
Set the width and height of the element associated with this UIObject.  The
values should be given as a CSS value, such as 100px, 30%, or 50pi
setStyleName(self, element, style=None, add=True)
When called with a single argument, this replaces all the CSS classes
associated with this UIObject's element with the given parameter.  Otherwise,
this is assumed to be a worker function for addStyleName and removeStyleName.
setTitle(self, title)
setVisible(self, element, visible=None)
Set whether this element is visible or not.  If a single parameter is
given, the self.element is used.  This modifies the CSS property 'display',
which means that an invisible element not only is not drawn, but doesn't
occupy any space on the page.
setWidth(self, width)
Set the width of the element associated with this UIObject.  The
value should be given as a CSS value, such as 100px, 30%, or 50pi
setzIndex(self, index)
sinkEvents(self, eventBitsToAdd)
Request that the given events be delivered to the event handler for this
element.  The event bits passed are added (using inclusive OR) to the events
already "sunk" for the element associated with the UIObject.  The event bits
are a combination of values from class L{Event}.
unsinkEvents(self, eventBitsToRemove)
Reverse the operation of sinkEvents.  See L{UIObject.sinkEvents}.
''', 'Hyperlink': r'''

 
class Hyperlink(Widget)
    A widget that serves as an "internal" hyperlink. That is, it is a
link to another state of the running application. When clicked,
it will create a new history frame using
History.newItem(targetHistoryToken), but without reloading the page.
 
Being a true hyperlink, it is also possible for the user to
"right-click, open link in new window", which will cause the
application to be loaded in a new window at the state specified
by the hyperlink.
 
 
Method resolution order:
Hyperlink
Widget
UIObject
Methods defined here:
__init__(self, text='', asHTML=False, targetHistoryToken='')
addClickListener(self, listener)
getHTML(self)
getTargetHistoryToken(self)
getText(self)
onBrowserEvent(self, event)
removeClickListener(self, listener)
setHTML(self, html)
setTargetHistoryToken(self, targetHistoryToken)
setText(self, text)
Methods inherited from Widget:
getID(self)
Get the id attribute of the associated DOM element.
getLayoutData(self)
getParent(self)
Widgets are kept in a hierarchy, and widgets that have been added to a panel
will have a parent widget that contains them.  This retrieves the containing
widget for this widget.
isAttached(self)
Return whether or not this widget has been attached to the document.
onAttach(self)
Called when this widget has an element, and that element is on the document's
DOM tree, and we have a parent widget.
onDetach(self)
Called when this widget is being removed from the DOM tree of the document.
onLoad(self, sender)
removeFromParent(self)
Remove ourself from our parent.  The parent widget will call setParent(None) on
us automatically
setID(self, id)
Set the id attribute of the associated DOM element.
setLayoutData(self, layoutData)
setParent(self, parent)
Update the parent attribute.  If the parent is currently attached to the DOM this
assumes we are being attached also and calls onAttach().
Methods inherited from UIObject:
addStyleName(self, style)
Append a style to the element associated with this UIObject.  This is
a CSS class name.  It will be added after any already-assigned CSS class for
the element.
getAbsoluteLeft(self)
getAbsoluteTop(self)
getElement(self)
Get the DOM element associated with the UIObject, if any
getOffsetHeight(self)
getOffsetWidth(self)
getStyleName(self)
getTitle(self)
isVisible(self, element=None)
Determine whether this element is currently visible, by checking the CSS
property 'display'
removeStyleName(self, style)
Remove a style from the element associated with this UIObject.  This is
a CSS class name.
setElement(self, element)
Set the DOM element associated with the UIObject.
setHeight(self, height)
Set the height of the element associated with this UIObject.  The
value should be given as a CSS value, such as 100px, 30%, or 50pi
setPixelSize(self, width, height)
Set the width and height of the element associated with this UIObject
in pixels.  Width and height should be numbers.
setSize(self, width, height)
Set the width and height of the element associated with this UIObject.  The
values should be given as a CSS value, such as 100px, 30%, or 50pi
setStyleName(self, element, style=None, add=True)
When called with a single argument, this replaces all the CSS classes
associated with this UIObject's element with the given parameter.  Otherwise,
this is assumed to be a worker function for addStyleName and removeStyleName.
setTitle(self, title)
setVisible(self, element, visible=None)
Set whether this element is visible or not.  If a single parameter is
given, the self.element is used.  This modifies the CSS property 'display',
which means that an invisible element not only is not drawn, but doesn't
occupy any space on the page.
setWidth(self, width)
Set the width of the element associated with this UIObject.  The
value should be given as a CSS value, such as 100px, 30%, or 50pi
setzIndex(self, index)
sinkEvents(self, eventBitsToAdd)
Request that the given events be delivered to the event handler for this
element.  The event bits passed are added (using inclusive OR) to the events
already "sunk" for the element associated with the UIObject.  The event bits
are a combination of values from class L{Event}.
unsinkEvents(self, eventBitsToRemove)
Reverse the operation of sinkEvents.  See L{UIObject.sinkEvents}.
''', 'StackPanel': r'''

 
class StackPanel(ComplexPanel)
    A panel that stacks its children vertically, displaying only one at
a time, with a header for each child which the user can click to
display.
 
 
Method resolution order:
StackPanel
ComplexPanel
Panel
Widget
UIObject
Methods defined here:
__init__(self)
add(self, widget, stackText='', asHTML=False)
getDividerIndex(self, elem)
getSelectedIndex(self)
getWidget(self, index)
getWidgetCount(self)
getWidgetIndex(self, child)
onBrowserEvent(self, event)
remove(self, child, index=None)
# also callable as remove(child) and remove(index)
setStackText(self, index, text, asHTML=False)
setStackVisible(self, index, visible)
showStack(self, index)
Methods inherited from ComplexPanel:
getChildren(self)
insert(self, widget, container, beforeIndex)
Methods inherited from Panel:
__iter__(self)
adopt(self, widget, container)
clear(self)
# TODO: fix iterator remove()
disown(self, widget)
onAttach(self)
onDetach(self)
Methods inherited from Widget:
getID(self)
Get the id attribute of the associated DOM element.
getLayoutData(self)
getParent(self)
Widgets are kept in a hierarchy, and widgets that have been added to a panel
will have a parent widget that contains them.  This retrieves the containing
widget for this widget.
isAttached(self)
Return whether or not this widget has been attached to the document.
onLoad(self, sender)
removeFromParent(self)
Remove ourself from our parent.  The parent widget will call setParent(None) on
us automatically
setID(self, id)
Set the id attribute of the associated DOM element.
setLayoutData(self, layoutData)
setParent(self, parent)
Update the parent attribute.  If the parent is currently attached to the DOM this
assumes we are being attached also and calls onAttach().
Methods inherited from UIObject:
addStyleName(self, style)
Append a style to the element associated with this UIObject.  This is
a CSS class name.  It will be added after any already-assigned CSS class for
the element.
getAbsoluteLeft(self)
getAbsoluteTop(self)
getElement(self)
Get the DOM element associated with the UIObject, if any
getOffsetHeight(self)
getOffsetWidth(self)
getStyleName(self)
getTitle(self)
isVisible(self, element=None)
Determine whether this element is currently visible, by checking the CSS
property 'display'
removeStyleName(self, style)
Remove a style from the element associated with this UIObject.  This is
a CSS class name.
setElement(self, element)
Set the DOM element associated with the UIObject.
setHeight(self, height)
Set the height of the element associated with this UIObject.  The
value should be given as a CSS value, such as 100px, 30%, or 50pi
setPixelSize(self, width, height)
Set the width and height of the element associated with this UIObject
in pixels.  Width and height should be numbers.
setSize(self, width, height)
Set the width and height of the element associated with this UIObject.  The
values should be given as a CSS value, such as 100px, 30%, or 50pi
setStyleName(self, element, style=None, add=True)
When called with a single argument, this replaces all the CSS classes
associated with this UIObject's element with the given parameter.  Otherwise,
this is assumed to be a worker function for addStyleName and removeStyleName.
setTitle(self, title)
setVisible(self, element, visible=None)
Set whether this element is visible or not.  If a single parameter is
given, the self.element is used.  This modifies the CSS property 'display',
which means that an invisible element not only is not drawn, but doesn't
occupy any space on the page.
setWidth(self, width)
Set the width of the element associated with this UIObject.  The
value should be given as a CSS value, such as 100px, 30%, or 50pi
setzIndex(self, index)
sinkEvents(self, eventBitsToAdd)
Request that the given events be delivered to the event handler for this
element.  The event bits passed are added (using inclusive OR) to the events
already "sunk" for the element associated with the UIObject.  The event bits
are a combination of values from class L{Event}.
unsinkEvents(self, eventBitsToRemove)
Reverse the operation of sinkEvents.  See L{UIObject.sinkEvents}.
''', 'Button': r'''

 
class Button(ButtonBase)
    Button is a clickable button.
 
 
Method resolution order:
Button
ButtonBase
FocusWidget
Widget
UIObject
Methods defined here:
__init__(self, html=None, listener=None)
Create a new button widget.
 
@param html: Html content (e.g. the button label); see setHTML()
@param listener: A new click listener; see addClickListener()
adjustType(self, button)
click(self)
Simulate a button click.
Methods inherited from ButtonBase:
getHTML(self)
getText(self)
setHTML(self, html)
setText(self, text)
Methods inherited from FocusWidget:
addClickListener(self, listener)
addFocusListener(self, listener)
addKeyboardListener(self, listener)
getTabIndex(self)
isEnabled(self)
onBrowserEvent(self, event)
removeClickListener(self, listener)
removeFocusListener(self, listener)
removeKeyboardListener(self, listener)
setAccessKey(self, key)
setEnabled(self, enabled)
setFocus(self, focused)
setTabIndex(self, index)
Methods inherited from Widget:
getID(self)
Get the id attribute of the associated DOM element.
getLayoutData(self)
getParent(self)
Widgets are kept in a hierarchy, and widgets that have been added to a panel
will have a parent widget that contains them.  This retrieves the containing
widget for this widget.
isAttached(self)
Return whether or not this widget has been attached to the document.
onAttach(self)
Called when this widget has an element, and that element is on the document's
DOM tree, and we have a parent widget.
onDetach(self)
Called when this widget is being removed from the DOM tree of the document.
onLoad(self, sender)
removeFromParent(self)
Remove ourself from our parent.  The parent widget will call setParent(None) on
us automatically
setID(self, id)
Set the id attribute of the associated DOM element.
setLayoutData(self, layoutData)
setParent(self, parent)
Update the parent attribute.  If the parent is currently attached to the DOM this
assumes we are being attached also and calls onAttach().
Methods inherited from UIObject:
addStyleName(self, style)
Append a style to the element associated with this UIObject.  This is
a CSS class name.  It will be added after any already-assigned CSS class for
the element.
getAbsoluteLeft(self)
getAbsoluteTop(self)
getElement(self)
Get the DOM element associated with the UIObject, if any
getOffsetHeight(self)
getOffsetWidth(self)
getStyleName(self)
getTitle(self)
isVisible(self, element=None)
Determine whether this element is currently visible, by checking the CSS
property 'display'
removeStyleName(self, style)
Remove a style from the element associated with this UIObject.  This is
a CSS class name.
setElement(self, element)
Set the DOM element associated with the UIObject.
setHeight(self, height)
Set the height of the element associated with this UIObject.  The
value should be given as a CSS value, such as 100px, 30%, or 50pi
setPixelSize(self, width, height)
Set the width and height of the element associated with this UIObject
in pixels.  Width and height should be numbers.
setSize(self, width, height)
Set the width and height of the element associated with this UIObject.  The
values should be given as a CSS value, such as 100px, 30%, or 50pi
setStyleName(self, element, style=None, add=True)
When called with a single argument, this replaces all the CSS classes
associated with this UIObject's element with the given parameter.  Otherwise,
this is assumed to be a worker function for addStyleName and removeStyleName.
setTitle(self, title)
setVisible(self, element, visible=None)
Set whether this element is visible or not.  If a single parameter is
given, the self.element is used.  This modifies the CSS property 'display',
which means that an invisible element not only is not drawn, but doesn't
occupy any space on the page.
setWidth(self, width)
Set the width of the element associated with this UIObject.  The
value should be given as a CSS value, such as 100px, 30%, or 50pi
setzIndex(self, index)
sinkEvents(self, eventBitsToAdd)
Request that the given events be delivered to the event handler for this
element.  The event bits passed are added (using inclusive OR) to the events
already "sunk" for the element associated with the UIObject.  The event bits
are a combination of values from class L{Event}.
unsinkEvents(self, eventBitsToRemove)
Reverse the operation of sinkEvents.  See L{UIObject.sinkEvents}.
''', 'Tree': r'''

 
class Tree(Widget)
    A standard hierarchical tree widget. The tree contains a hierarchy
of TreeItems that the user can open, close, and select.
 
 
Method resolution order:
Tree
Widget
UIObject
Methods defined here:
__init__(self)
__iter__(self)
add(self, widget)
addFocusListener(self, listener)
addItem(self, item)
addKeyboardListener(self, listener)
addMouseListener(self, listener)
addTreeListener(self, listener)
adopt(self, content)
clear(self)
collectElementChain(self, chain, hRoot, hElem)
disown(self, item)
elementClicked(self, root, hElem)
ensureSelectedItemVisible(self)
findDeepestOpenChild(self, item)
findItemByChain(self, chain, idx, root)
fireStateChanged(self, item)
getChildWidgets(self)
getImageBase(self)
getItem(self, index)
getItemCount(self)
getSelectedItem(self)
getTabIndex(self)
moveFocus(self, selection)
moveSelectionDown(self, sel, dig)
moveSelectionUp(self, sel, climb)
onAttach(self)
onBrowserEvent(self, event)
onDetach(self)
onLoad(self, sender)
onSelection(self, item, fireEvents)
remove(self, widget)
removeFocusListener(self, listener)
removeItem(self, item)
removeItems(self)
removeKeyboardListener(self, listener)
removeTreeListener(self, listener)
setAccessKey(self, key)
setFocus(self, focus)
setImageBase(self, baseUrl)
setSelectedItem(self, item, fireEvents=True)
setTabIndex(self, index)
shouldTreeDelegateFocusToElement(self, elem)
treeItemIterator(self)
Methods inherited from Widget:
getID(self)
Get the id attribute of the associated DOM element.
getLayoutData(self)
getParent(self)
Widgets are kept in a hierarchy, and widgets that have been added to a panel
will have a parent widget that contains them.  This retrieves the containing
widget for this widget.
isAttached(self)
Return whether or not this widget has been attached to the document.
removeFromParent(self)
Remove ourself from our parent.  The parent widget will call setParent(None) on
us automatically
setID(self, id)
Set the id attribute of the associated DOM element.
setLayoutData(self, layoutData)
setParent(self, parent)
Update the parent attribute.  If the parent is currently attached to the DOM this
assumes we are being attached also and calls onAttach().
Methods inherited from UIObject:
addStyleName(self, style)
Append a style to the element associated with this UIObject.  This is
a CSS class name.  It will be added after any already-assigned CSS class for
the element.
getAbsoluteLeft(self)
getAbsoluteTop(self)
getElement(self)
Get the DOM element associated with the UIObject, if any
getOffsetHeight(self)
getOffsetWidth(self)
getStyleName(self)
getTitle(self)
isVisible(self, element=None)
Determine whether this element is currently visible, by checking the CSS
property 'display'
removeStyleName(self, style)
Remove a style from the element associated with this UIObject.  This is
a CSS class name.
setElement(self, element)
Set the DOM element associated with the UIObject.
setHeight(self, height)
Set the height of the element associated with this UIObject.  The
value should be given as a CSS value, such as 100px, 30%, or 50pi
setPixelSize(self, width, height)
Set the width and height of the element associated with this UIObject
in pixels.  Width and height should be numbers.
setSize(self, width, height)
Set the width and height of the element associated with this UIObject.  The
values should be given as a CSS value, such as 100px, 30%, or 50pi
setStyleName(self, element, style=None, add=True)
When called with a single argument, this replaces all the CSS classes
associated with this UIObject's element with the given parameter.  Otherwise,
this is assumed to be a worker function for addStyleName and removeStyleName.
setTitle(self, title)
setVisible(self, element, visible=None)
Set whether this element is visible or not.  If a single parameter is
given, the self.element is used.  This modifies the CSS property 'display',
which means that an invisible element not only is not drawn, but doesn't
occupy any space on the page.
setWidth(self, width)
Set the width of the element associated with this UIObject.  The
value should be given as a CSS value, such as 100px, 30%, or 50pi
setzIndex(self, index)
sinkEvents(self, eventBitsToAdd)
Request that the given events be delivered to the event handler for this
element.  The event bits passed are added (using inclusive OR) to the events
already "sunk" for the element associated with the UIObject.  The event bits
are a combination of values from class L{Event}.
unsinkEvents(self, eventBitsToRemove)
Reverse the operation of sinkEvents.  See L{UIObject.sinkEvents}.
''', 'ScrollPanel': r'''

 
class ScrollPanel(SimplePanel)
    A simple panel that wraps its contents in a scrollable area.
 
 
Method resolution order:
ScrollPanel
SimplePanel
Panel
Widget
UIObject
Methods defined here:
__init__(self, child=None)
addScrollListener(self, listener)
ensureVisible(self, item)
ensureVisibleImpl(self, scroll, e)
getHorizontalScrollPosition(self)
getScrollPosition(self)
onBrowserEvent(self, event)
removeScrollListener(self, listener)
setAlwaysShowScrollBars(self, alwaysShow)
setHorizontalScrollPosition(self, position)
setScrollPosition(self, position)
Methods inherited from SimplePanel:
add(self, widget)
getContainerElement(self)
getWidget(self)
remove(self, widget)
setWidget(self, widget)
Methods inherited from Panel:
__iter__(self)
adopt(self, widget, container)
clear(self)
# TODO: fix iterator remove()
disown(self, widget)
onAttach(self)
onDetach(self)
Methods inherited from Widget:
getID(self)
Get the id attribute of the associated DOM element.
getLayoutData(self)
getParent(self)
Widgets are kept in a hierarchy, and widgets that have been added to a panel
will have a parent widget that contains them.  This retrieves the containing
widget for this widget.
isAttached(self)
Return whether or not this widget has been attached to the document.
onLoad(self, sender)
removeFromParent(self)
Remove ourself from our parent.  The parent widget will call setParent(None) on
us automatically
setID(self, id)
Set the id attribute of the associated DOM element.
setLayoutData(self, layoutData)
setParent(self, parent)
Update the parent attribute.  If the parent is currently attached to the DOM this
assumes we are being attached also and calls onAttach().
Methods inherited from UIObject:
addStyleName(self, style)
Append a style to the element associated with this UIObject.  This is
a CSS class name.  It will be added after any already-assigned CSS class for
the element.
getAbsoluteLeft(self)
getAbsoluteTop(self)
getElement(self)
Get the DOM element associated with the UIObject, if any
getOffsetHeight(self)
getOffsetWidth(self)
getStyleName(self)
getTitle(self)
isVisible(self, element=None)
Determine whether this element is currently visible, by checking the CSS
property 'display'
removeStyleName(self, style)
Remove a style from the element associated with this UIObject.  This is
a CSS class name.
setElement(self, element)
Set the DOM element associated with the UIObject.
setHeight(self, height)
Set the height of the element associated with this UIObject.  The
value should be given as a CSS value, such as 100px, 30%, or 50pi
setPixelSize(self, width, height)
Set the width and height of the element associated with this UIObject
in pixels.  Width and height should be numbers.
setSize(self, width, height)
Set the width and height of the element associated with this UIObject.  The
values should be given as a CSS value, such as 100px, 30%, or 50pi
setStyleName(self, element, style=None, add=True)
When called with a single argument, this replaces all the CSS classes
associated with this UIObject's element with the given parameter.  Otherwise,
this is assumed to be a worker function for addStyleName and removeStyleName.
setTitle(self, title)
setVisible(self, element, visible=None)
Set whether this element is visible or not.  If a single parameter is
given, the self.element is used.  This modifies the CSS property 'display',
which means that an invisible element not only is not drawn, but doesn't
occupy any space on the page.
setWidth(self, width)
Set the width of the element associated with this UIObject.  The
value should be given as a CSS value, such as 100px, 30%, or 50pi
setzIndex(self, index)
sinkEvents(self, eventBitsToAdd)
Request that the given events be delivered to the event handler for this
element.  The event bits passed are added (using inclusive OR) to the events
already "sunk" for the element associated with the UIObject.  The event bits
are a combination of values from class L{Event}.
unsinkEvents(self, eventBitsToRemove)
Reverse the operation of sinkEvents.  See L{UIObject.sinkEvents}.
''', 'ComplexPanel': r'''

 
class ComplexPanel(Panel)
    Superclass for widgets with multiple children.
 
 
Method resolution order:
ComplexPanel
Panel
Widget
UIObject
Methods defined here:
__init__(self)
add(self, widget, container)
getChildren(self)
insert(self, widget, container, beforeIndex)
remove(self, widget)
Methods inherited from Panel:
__iter__(self)
adopt(self, widget, container)
clear(self)
# TODO: fix iterator remove()
disown(self, widget)
onAttach(self)
onDetach(self)
Methods inherited from Widget:
getID(self)
Get the id attribute of the associated DOM element.
getLayoutData(self)
getParent(self)
Widgets are kept in a hierarchy, and widgets that have been added to a panel
will have a parent widget that contains them.  This retrieves the containing
widget for this widget.
isAttached(self)
Return whether or not this widget has been attached to the document.
onBrowserEvent(self, event)
onLoad(self, sender)
removeFromParent(self)
Remove ourself from our parent.  The parent widget will call setParent(None) on
us automatically
setID(self, id)
Set the id attribute of the associated DOM element.
setLayoutData(self, layoutData)
setParent(self, parent)
Update the parent attribute.  If the parent is currently attached to the DOM this
assumes we are being attached also and calls onAttach().
Methods inherited from UIObject:
addStyleName(self, style)
Append a style to the element associated with this UIObject.  This is
a CSS class name.  It will be added after any already-assigned CSS class for
the element.
getAbsoluteLeft(self)
getAbsoluteTop(self)
getElement(self)
Get the DOM element associated with the UIObject, if any
getOffsetHeight(self)
getOffsetWidth(self)
getStyleName(self)
getTitle(self)
isVisible(self, element=None)
Determine whether this element is currently visible, by checking the CSS
property 'display'
removeStyleName(self, style)
Remove a style from the element associated with this UIObject.  This is
a CSS class name.
setElement(self, element)
Set the DOM element associated with the UIObject.
setHeight(self, height)
Set the height of the element associated with this UIObject.  The
value should be given as a CSS value, such as 100px, 30%, or 50pi
setPixelSize(self, width, height)
Set the width and height of the element associated with this UIObject
in pixels.  Width and height should be numbers.
setSize(self, width, height)
Set the width and height of the element associated with this UIObject.  The
values should be given as a CSS value, such as 100px, 30%, or 50pi
setStyleName(self, element, style=None, add=True)
When called with a single argument, this replaces all the CSS classes
associated with this UIObject's element with the given parameter.  Otherwise,
this is assumed to be a worker function for addStyleName and removeStyleName.
setTitle(self, title)
setVisible(self, element, visible=None)
Set whether this element is visible or not.  If a single parameter is
given, the self.element is used.  This modifies the CSS property 'display',
which means that an invisible element not only is not drawn, but doesn't
occupy any space on the page.
setWidth(self, width)
Set the width of the element associated with this UIObject.  The
value should be given as a CSS value, such as 100px, 30%, or 50pi
setzIndex(self, index)
sinkEvents(self, eventBitsToAdd)
Request that the given events be delivered to the event handler for this
element.  The event bits passed are added (using inclusive OR) to the events
already "sunk" for the element associated with the UIObject.  The event bits
are a combination of values from class L{Event}.
unsinkEvents(self, eventBitsToRemove)
Reverse the operation of sinkEvents.  See L{UIObject.sinkEvents}.
''', 'FormPanel': r'''

 
class FormPanel(SimplePanel)
    A panel that wraps its contents in an HTML <FORM> element.
 
This panel can be used to achieve interoperability with servers
that accept traditional HTML form encoding. The following widgets
will be submitted to the server if they are contained within this panel:
 
* L{TextBox}
* L{PasswordTextBox}
* L{RadioButton}
* L{CheckBox}
* L{TextArea}
* L{ListBox}
* L{FileUpload}
* L{Hidden}
 
In particular, FileUpload is only useful when used within a
L{FormPanel}, because the browser will only upload files using
form submission.
 
 
Method resolution order:
FormPanel
SimplePanel
Panel
Widget
UIObject
Methods defined here:
__init__(self, target=None)
addFormHandler(self, handler)
getAction(self)
getEncoding(self)
# FormPanelImpl.getEncoding
getMethod(self)
getTarget(self)
getTextContents(self, iframe)
# FormPanelImpl.getTextContents
hookEvents(self, iframe, form, listener)
# FormPanelImpl.hookEvents
onAttach(self)
onDetach(self)
onFormSubmit(self)
onFrameLoad(self)
removeFormHandler(self, handler)
setAction(self, url)
setEncoding(self, encodingType)
# FormPanelImpl.setEncoding
setMethod(self, method)
setTarget(self, target)
submit(self)
submitImpl(self, form, iframe)
# FormPanelImpl.submit
unhookEvents(self, iframe, form)
# FormPanelImpl.unhookEvents
Data and other attributes defined here:
ENCODING_MULTIPART = 'multipart/form-data'
ENCODING_URLENCODED = 'application/x-www-form-urlencoded'
METHOD_GET = 'get'
METHOD_POST = 'post'
Methods inherited from SimplePanel:
add(self, widget)
getContainerElement(self)
getWidget(self)
remove(self, widget)
setWidget(self, widget)
Methods inherited from Panel:
__iter__(self)
adopt(self, widget, container)
clear(self)
# TODO: fix iterator remove()
disown(self, widget)
Methods inherited from Widget:
getID(self)
Get the id attribute of the associated DOM element.
getLayoutData(self)
getParent(self)
Widgets are kept in a hierarchy, and widgets that have been added to a panel
will have a parent widget that contains them.  This retrieves the containing
widget for this widget.
isAttached(self)
Return whether or not this widget has been attached to the document.
onBrowserEvent(self, event)
onLoad(self, sender)
removeFromParent(self)
Remove ourself from our parent.  The parent widget will call setParent(None) on
us automatically
setID(self, id)
Set the id attribute of the associated DOM element.
setLayoutData(self, layoutData)
setParent(self, parent)
Update the parent attribute.  If the parent is currently attached to the DOM this
assumes we are being attached also and calls onAttach().
Methods inherited from UIObject:
addStyleName(self, style)
Append a style to the element associated with this UIObject.  This is
a CSS class name.  It will be added after any already-assigned CSS class for
the element.
getAbsoluteLeft(self)
getAbsoluteTop(self)
getElement(self)
Get the DOM element associated with the UIObject, if any
getOffsetHeight(self)
getOffsetWidth(self)
getStyleName(self)
getTitle(self)
isVisible(self, element=None)
Determine whether this element is currently visible, by checking the CSS
property 'display'
removeStyleName(self, style)
Remove a style from the element associated with this UIObject.  This is
a CSS class name.
setElement(self, element)
Set the DOM element associated with the UIObject.
setHeight(self, height)
Set the height of the element associated with this UIObject.  The
value should be given as a CSS value, such as 100px, 30%, or 50pi
setPixelSize(self, width, height)
Set the width and height of the element associated with this UIObject
in pixels.  Width and height should be numbers.
setSize(self, width, height)
Set the width and height of the element associated with this UIObject.  The
values should be given as a CSS value, such as 100px, 30%, or 50pi
setStyleName(self, element, style=None, add=True)
When called with a single argument, this replaces all the CSS classes
associated with this UIObject's element with the given parameter.  Otherwise,
this is assumed to be a worker function for addStyleName and removeStyleName.
setTitle(self, title)
setVisible(self, element, visible=None)
Set whether this element is visible or not.  If a single parameter is
given, the self.element is used.  This modifies the CSS property 'display',
which means that an invisible element not only is not drawn, but doesn't
occupy any space on the page.
setWidth(self, width)
Set the width of the element associated with this UIObject.  The
value should be given as a CSS value, such as 100px, 30%, or 50pi
setzIndex(self, index)
sinkEvents(self, eventBitsToAdd)
Request that the given events be delivered to the event handler for this
element.  The event bits passed are added (using inclusive OR) to the events
already "sunk" for the element associated with the UIObject.  The event bits
are a combination of values from class L{Event}.
unsinkEvents(self, eventBitsToRemove)
Reverse the operation of sinkEvents.  See L{UIObject.sinkEvents}.
''', 'TabBar': r'''

 
class TabBar(Composite)
    A horizontal bar of folder-style tabs, most commonly used as
part of a TabPanel.
 
 
Method resolution order:
TabBar
Composite
Widget
UIObject
Methods defined here:
__init__(self)
addTab(self, text, asHTML=False)
addTabListener(self, listener)
checkTabIndex(self, index)
getSelectedTab(self)
getTabCount(self)
getTabHTML(self, index)
insertTab(self, text, asHTML, beforeIndex=None)
onClick(self, sender)
removeTab(self, index)
removeTabListener(self, listener)
selectTab(self, index)
setSelectionStyle(self, item, selected)
Methods inherited from Composite:
initWidget(self, widget)
onAttach(self)
onDetach(self)
setWidget(self, widget)
Methods inherited from Widget:
getID(self)
Get the id attribute of the associated DOM element.
getLayoutData(self)
getParent(self)
Widgets are kept in a hierarchy, and widgets that have been added to a panel
will have a parent widget that contains them.  This retrieves the containing
widget for this widget.
isAttached(self)
Return whether or not this widget has been attached to the document.
onBrowserEvent(self, event)
onLoad(self, sender)
removeFromParent(self)
Remove ourself from our parent.  The parent widget will call setParent(None) on
us automatically
setID(self, id)
Set the id attribute of the associated DOM element.
setLayoutData(self, layoutData)
setParent(self, parent)
Update the parent attribute.  If the parent is currently attached to the DOM this
assumes we are being attached also and calls onAttach().
Methods inherited from UIObject:
addStyleName(self, style)
Append a style to the element associated with this UIObject.  This is
a CSS class name.  It will be added after any already-assigned CSS class for
the element.
getAbsoluteLeft(self)
getAbsoluteTop(self)
getElement(self)
Get the DOM element associated with the UIObject, if any
getOffsetHeight(self)
getOffsetWidth(self)
getStyleName(self)
getTitle(self)
isVisible(self, element=None)
Determine whether this element is currently visible, by checking the CSS
property 'display'
removeStyleName(self, style)
Remove a style from the element associated with this UIObject.  This is
a CSS class name.
setElement(self, element)
Set the DOM element associated with the UIObject.
setHeight(self, height)
Set the height of the element associated with this UIObject.  The
value should be given as a CSS value, such as 100px, 30%, or 50pi
setPixelSize(self, width, height)
Set the width and height of the element associated with this UIObject
in pixels.  Width and height should be numbers.
setSize(self, width, height)
Set the width and height of the element associated with this UIObject.  The
values should be given as a CSS value, such as 100px, 30%, or 50pi
setStyleName(self, element, style=None, add=True)
When called with a single argument, this replaces all the CSS classes
associated with this UIObject's element with the given parameter.  Otherwise,
this is assumed to be a worker function for addStyleName and removeStyleName.
setTitle(self, title)
setVisible(self, element, visible=None)
Set whether this element is visible or not.  If a single parameter is
given, the self.element is used.  This modifies the CSS property 'display',
which means that an invisible element not only is not drawn, but doesn't
occupy any space on the page.
setWidth(self, width)
Set the width of the element associated with this UIObject.  The
value should be given as a CSS value, such as 100px, 30%, or 50pi
setzIndex(self, index)
sinkEvents(self, eventBitsToAdd)
Request that the given events be delivered to the event handler for this
element.  The event bits passed are added (using inclusive OR) to the events
already "sunk" for the element associated with the UIObject.  The event bits
are a combination of values from class L{Event}.
unsinkEvents(self, eventBitsToRemove)
Reverse the operation of sinkEvents.  See L{UIObject.sinkEvents}.
''', 'CellPanel': r'''

 
class CellPanel(ComplexPanel)
    A panel whose child widgets are contained within the cells of a table.
 
Each cell's size may be set independently.
Each child widget can take up a subset of its cell
and can be aligned within it.
 
 
Method resolution order:
CellPanel
ComplexPanel
Panel
Widget
UIObject
Methods defined here:
__init__(self)
getBody(self)
getSpacing(self)
getTable(self)
getWidgetTd(self, widget)
setBorderWidth(self, width)
setCellHeight(self, widget, height)
setCellHorizontalAlignment(self, widget, align)
setCellVerticalAlignment(self, widget, align)
setCellWidth(self, widget, width)
setSpacing(self, spacing)
Methods inherited from ComplexPanel:
add(self, widget, container)
getChildren(self)
insert(self, widget, container, beforeIndex)
remove(self, widget)
Methods inherited from Panel:
__iter__(self)
adopt(self, widget, container)
clear(self)
# TODO: fix iterator remove()
disown(self, widget)
onAttach(self)
onDetach(self)
Methods inherited from Widget:
getID(self)
Get the id attribute of the associated DOM element.
getLayoutData(self)
getParent(self)
Widgets are kept in a hierarchy, and widgets that have been added to a panel
will have a parent widget that contains them.  This retrieves the containing
widget for this widget.
isAttached(self)
Return whether or not this widget has been attached to the document.
onBrowserEvent(self, event)
onLoad(self, sender)
removeFromParent(self)
Remove ourself from our parent.  The parent widget will call setParent(None) on
us automatically
setID(self, id)
Set the id attribute of the associated DOM element.
setLayoutData(self, layoutData)
setParent(self, parent)
Update the parent attribute.  If the parent is currently attached to the DOM this
assumes we are being attached also and calls onAttach().
Methods inherited from UIObject:
addStyleName(self, style)
Append a style to the element associated with this UIObject.  This is
a CSS class name.  It will be added after any already-assigned CSS class for
the element.
getAbsoluteLeft(self)
getAbsoluteTop(self)
getElement(self)
Get the DOM element associated with the UIObject, if any
getOffsetHeight(self)
getOffsetWidth(self)
getStyleName(self)
getTitle(self)
isVisible(self, element=None)
Determine whether this element is currently visible, by checking the CSS
property 'display'
removeStyleName(self, style)
Remove a style from the element associated with this UIObject.  This is
a CSS class name.
setElement(self, element)
Set the DOM element associated with the UIObject.
setHeight(self, height)
Set the height of the element associated with this UIObject.  The
value should be given as a CSS value, such as 100px, 30%, or 50pi
setPixelSize(self, width, height)
Set the width and height of the element associated with this UIObject
in pixels.  Width and height should be numbers.
setSize(self, width, height)
Set the width and height of the element associated with this UIObject.  The
values should be given as a CSS value, such as 100px, 30%, or 50pi
setStyleName(self, element, style=None, add=True)
When called with a single argument, this replaces all the CSS classes
associated with this UIObject's element with the given parameter.  Otherwise,
this is assumed to be a worker function for addStyleName and removeStyleName.
setTitle(self, title)
setVisible(self, element, visible=None)
Set whether this element is visible or not.  If a single parameter is
given, the self.element is used.  This modifies the CSS property 'display',
which means that an invisible element not only is not drawn, but doesn't
occupy any space on the page.
setWidth(self, width)
Set the width of the element associated with this UIObject.  The
value should be given as a CSS value, such as 100px, 30%, or 50pi
setzIndex(self, index)
sinkEvents(self, eventBitsToAdd)
Request that the given events be delivered to the event handler for this
element.  The event bits passed are added (using inclusive OR) to the events
already "sunk" for the element associated with the UIObject.  The event bits
are a combination of values from class L{Event}.
unsinkEvents(self, eventBitsToRemove)
Reverse the operation of sinkEvents.  See L{UIObject.sinkEvents}.
''', 'DialogBox': r'''

 
class DialogBox(PopupPanel)
    A form of popup that has a caption area at the top and can
be dragged by the user.
 
 
Method resolution order:
DialogBox
PopupPanel
SimplePanel
Panel
Widget
UIObject
Methods defined here:
__init__(self, autoHide=None)
getHTML(self)
getText(self)
onMouseDown(self, sender, x, y)
onMouseEnter(self, sender)
onMouseLeave(self, sender)
onMouseMove(self, sender, x, y)
onMouseUp(self, sender, x, y)
remove(self, widget)
setHTML(self, html)
setText(self, text)
setWidget(self, widget)
Methods inherited from PopupPanel:
addPopupListener(self, listener)
createElement(self)
# PopupImpl.createElement
getPopupLeft(self)
getPopupTop(self)
hide(self, autoClosed=False)
onEventPreview(self, event)
onHideImpl(self, popup)
# PopupImpl.onHide
onKeyDownPreview(self, key, modifiers)
onKeyPressPreview(self, key, modifiers)
onKeyUpPreview(self, key, modifiers)
onShowImpl(self, popup)
# PopupImpl.onShow
removePopupListener(self, listener)
setPopupPosition(self, left, top)
show(self)
Methods inherited from SimplePanel:
add(self, widget)
getContainerElement(self)
getWidget(self)
Methods inherited from Panel:
__iter__(self)
adopt(self, widget, container)
clear(self)
# TODO: fix iterator remove()
disown(self, widget)
onAttach(self)
onDetach(self)
Methods inherited from Widget:
getID(self)
Get the id attribute of the associated DOM element.
getLayoutData(self)
getParent(self)
Widgets are kept in a hierarchy, and widgets that have been added to a panel
will have a parent widget that contains them.  This retrieves the containing
widget for this widget.
isAttached(self)
Return whether or not this widget has been attached to the document.
onBrowserEvent(self, event)
onLoad(self, sender)
removeFromParent(self)
Remove ourself from our parent.  The parent widget will call setParent(None) on
us automatically
setID(self, id)
Set the id attribute of the associated DOM element.
setLayoutData(self, layoutData)
setParent(self, parent)
Update the parent attribute.  If the parent is currently attached to the DOM this
assumes we are being attached also and calls onAttach().
Methods inherited from UIObject:
addStyleName(self, style)
Append a style to the element associated with this UIObject.  This is
a CSS class name.  It will be added after any already-assigned CSS class for
the element.
getAbsoluteLeft(self)
getAbsoluteTop(self)
getElement(self)
Get the DOM element associated with the UIObject, if any
getOffsetHeight(self)
getOffsetWidth(self)
getStyleName(self)
getTitle(self)
isVisible(self, element=None)
Determine whether this element is currently visible, by checking the CSS
property 'display'
removeStyleName(self, style)
Remove a style from the element associated with this UIObject.  This is
a CSS class name.
setElement(self, element)
Set the DOM element associated with the UIObject.
setHeight(self, height)
Set the height of the element associated with this UIObject.  The
value should be given as a CSS value, such as 100px, 30%, or 50pi
setPixelSize(self, width, height)
Set the width and height of the element associated with this UIObject
in pixels.  Width and height should be numbers.
setSize(self, width, height)
Set the width and height of the element associated with this UIObject.  The
values should be given as a CSS value, such as 100px, 30%, or 50pi
setStyleName(self, element, style=None, add=True)
When called with a single argument, this replaces all the CSS classes
associated with this UIObject's element with the given parameter.  Otherwise,
this is assumed to be a worker function for addStyleName and removeStyleName.
setTitle(self, title)
setVisible(self, element, visible=None)
Set whether this element is visible or not.  If a single parameter is
given, the self.element is used.  This modifies the CSS property 'display',
which means that an invisible element not only is not drawn, but doesn't
occupy any space on the page.
setWidth(self, width)
Set the width of the element associated with this UIObject.  The
value should be given as a CSS value, such as 100px, 30%, or 50pi
setzIndex(self, index)
sinkEvents(self, eventBitsToAdd)
Request that the given events be delivered to the event handler for this
element.  The event bits passed are added (using inclusive OR) to the events
already "sunk" for the element associated with the UIObject.  The event bits
are a combination of values from class L{Event}.
unsinkEvents(self, eventBitsToRemove)
Reverse the operation of sinkEvents.  See L{UIObject.sinkEvents}.
''', 'FlowPanel': r'''

 
class FlowPanel(ComplexPanel)
    A panel that formats its child widgets using default HTML layout
behavior.  Child widgets layout will therefore "flow" as the
FlowPanel panel is resized.  Usually this will be from left to
right, followed by filling the next available vertical space,
downwards, if a child widget cannot fit on the same horizontal
space.
 
 
Method resolution order:
FlowPanel
ComplexPanel
Panel
Widget
UIObject
Methods defined here:
__init__(self)
add(self, w)
getWidget(self, index)
getWidgetCount(self)
getWidgetIndex(self, child)
remove(self, index)
Methods inherited from ComplexPanel:
getChildren(self)
insert(self, widget, container, beforeIndex)
Methods inherited from Panel:
__iter__(self)
adopt(self, widget, container)
clear(self)
# TODO: fix iterator remove()
disown(self, widget)
onAttach(self)
onDetach(self)
Methods inherited from Widget:
getID(self)
Get the id attribute of the associated DOM element.
getLayoutData(self)
getParent(self)
Widgets are kept in a hierarchy, and widgets that have been added to a panel
will have a parent widget that contains them.  This retrieves the containing
widget for this widget.
isAttached(self)
Return whether or not this widget has been attached to the document.
onBrowserEvent(self, event)
onLoad(self, sender)
removeFromParent(self)
Remove ourself from our parent.  The parent widget will call setParent(None) on
us automatically
setID(self, id)
Set the id attribute of the associated DOM element.
setLayoutData(self, layoutData)
setParent(self, parent)
Update the parent attribute.  If the parent is currently attached to the DOM this
assumes we are being attached also and calls onAttach().
Methods inherited from UIObject:
addStyleName(self, style)
Append a style to the element associated with this UIObject.  This is
a CSS class name.  It will be added after any already-assigned CSS class for
the element.
getAbsoluteLeft(self)
getAbsoluteTop(self)
getElement(self)
Get the DOM element associated with the UIObject, if any
getOffsetHeight(self)
getOffsetWidth(self)
getStyleName(self)
getTitle(self)
isVisible(self, element=None)
Determine whether this element is currently visible, by checking the CSS
property 'display'
removeStyleName(self, style)
Remove a style from the element associated with this UIObject.  This is
a CSS class name.
setElement(self, element)
Set the DOM element associated with the UIObject.
setHeight(self, height)
Set the height of the element associated with this UIObject.  The
value should be given as a CSS value, such as 100px, 30%, or 50pi
setPixelSize(self, width, height)
Set the width and height of the element associated with this UIObject
in pixels.  Width and height should be numbers.
setSize(self, width, height)
Set the width and height of the element associated with this UIObject.  The
values should be given as a CSS value, such as 100px, 30%, or 50pi
setStyleName(self, element, style=None, add=True)
When called with a single argument, this replaces all the CSS classes
associated with this UIObject's element with the given parameter.  Otherwise,
this is assumed to be a worker function for addStyleName and removeStyleName.
setTitle(self, title)
setVisible(self, element, visible=None)
Set whether this element is visible or not.  If a single parameter is
given, the self.element is used.  This modifies the CSS property 'display',
which means that an invisible element not only is not drawn, but doesn't
occupy any space on the page.
setWidth(self, width)
Set the width of the element associated with this UIObject.  The
value should be given as a CSS value, such as 100px, 30%, or 50pi
setzIndex(self, index)
sinkEvents(self, eventBitsToAdd)
Request that the given events be delivered to the event handler for this
element.  The event bits passed are added (using inclusive OR) to the events
already "sunk" for the element associated with the UIObject.  The event bits
are a combination of values from class L{Event}.
unsinkEvents(self, eventBitsToRemove)
Reverse the operation of sinkEvents.  See L{UIObject.sinkEvents}.
''', 'ListBox': r'''

 
class ListBox(FocusWidget)
    A widget that presents a list of choices to the user, either as a
list box or as a drop-down list.
 
 
Method resolution order:
ListBox
FocusWidget
Widget
UIObject
Methods defined here:
__init__(self)
addChangeListener(self, listener)
addItem(self, item, value=None)
checkIndex(self, index)
clear(self)
getItemCount(self)
getItemText(self, index)
getName(self)
getSelectedIndex(self)
getValue(self, index)
getVisibleItemCount(self)
insertItem(self, item, value, index=None)
# also callable as insertItem(item, index)
isItemSelected(self, index)
isMultipleSelect(self)
onBrowserEvent(self, event)
removeChangeListener(self, listener)
removeItem(self, idx)
selectValue(self, value)
setItemSelected(self, index, selected)
setItemText(self, index, text)
setMultipleSelect(self, multiple)
setName(self, name)
setSelectedIndex(self, index)
setValue(self, index, value)
setVisibleItemCount(self, visibleItems)
Methods inherited from FocusWidget:
addClickListener(self, listener)
addFocusListener(self, listener)
addKeyboardListener(self, listener)
getTabIndex(self)
isEnabled(self)
removeClickListener(self, listener)
removeFocusListener(self, listener)
removeKeyboardListener(self, listener)
setAccessKey(self, key)
setEnabled(self, enabled)
setFocus(self, focused)
setTabIndex(self, index)
Methods inherited from Widget:
getID(self)
Get the id attribute of the associated DOM element.
getLayoutData(self)
getParent(self)
Widgets are kept in a hierarchy, and widgets that have been added to a panel
will have a parent widget that contains them.  This retrieves the containing
widget for this widget.
isAttached(self)
Return whether or not this widget has been attached to the document.
onAttach(self)
Called when this widget has an element, and that element is on the document's
DOM tree, and we have a parent widget.
onDetach(self)
Called when this widget is being removed from the DOM tree of the document.
onLoad(self, sender)
removeFromParent(self)
Remove ourself from our parent.  The parent widget will call setParent(None) on
us automatically
setID(self, id)
Set the id attribute of the associated DOM element.
setLayoutData(self, layoutData)
setParent(self, parent)
Update the parent attribute.  If the parent is currently attached to the DOM this
assumes we are being attached also and calls onAttach().
Methods inherited from UIObject:
addStyleName(self, style)
Append a style to the element associated with this UIObject.  This is
a CSS class name.  It will be added after any already-assigned CSS class for
the element.
getAbsoluteLeft(self)
getAbsoluteTop(self)
getElement(self)
Get the DOM element associated with the UIObject, if any
getOffsetHeight(self)
getOffsetWidth(self)
getStyleName(self)
getTitle(self)
isVisible(self, element=None)
Determine whether this element is currently visible, by checking the CSS
property 'display'
removeStyleName(self, style)
Remove a style from the element associated with this UIObject.  This is
a CSS class name.
setElement(self, element)
Set the DOM element associated with the UIObject.
setHeight(self, height)
Set the height of the element associated with this UIObject.  The
value should be given as a CSS value, such as 100px, 30%, or 50pi
setPixelSize(self, width, height)
Set the width and height of the element associated with this UIObject
in pixels.  Width and height should be numbers.
setSize(self, width, height)
Set the width and height of the element associated with this UIObject.  The
values should be given as a CSS value, such as 100px, 30%, or 50pi
setStyleName(self, element, style=None, add=True)
When called with a single argument, this replaces all the CSS classes
associated with this UIObject's element with the given parameter.  Otherwise,
this is assumed to be a worker function for addStyleName and removeStyleName.
setTitle(self, title)
setVisible(self, element, visible=None)
Set whether this element is visible or not.  If a single parameter is
given, the self.element is used.  This modifies the CSS property 'display',
which means that an invisible element not only is not drawn, but doesn't
occupy any space on the page.
setWidth(self, width)
Set the width of the element associated with this UIObject.  The
value should be given as a CSS value, such as 100px, 30%, or 50pi
setzIndex(self, index)
sinkEvents(self, eventBitsToAdd)
Request that the given events be delivered to the event handler for this
element.  The event bits passed are added (using inclusive OR) to the events
already "sunk" for the element associated with the UIObject.  The event bits
are a combination of values from class L{Event}.
unsinkEvents(self, eventBitsToRemove)
Reverse the operation of sinkEvents.  See L{UIObject.sinkEvents}.
''', 'FocusListener': r'''

 
class FocusListener
    # FocusListenerCollection
 
  Methods defined here:
fireFocusEvent(self, listeners, sender, event)
''', 'TextBox': r'''

 
class TextBox(TextBoxBase)
    TextBox is a standard single-line text box.
 
 
Method resolution order:
TextBox
TextBoxBase
FocusWidget
Widget
UIObject
Methods defined here:
__init__(self)
getMaxLength(self)
getVisibleLength(self)
setMaxLength(self, length)
setVisibleLength(self, length)
Methods inherited from TextBoxBase:
addChangeListener(self, listener)
addClickListener(self, listener)
addKeyboardListener(self, listener)
cancelKey(self)
getCursorPos(self)
getName(self)
getSelectedText(self)
getSelectionLength(self)
getText(self)
onBrowserEvent(self, event)
# BUG: keyboard & click events already fired in FocusWidget.onBrowserEvent
removeChangeListener(self, listener)
removeClickListener(self, listener)
removeKeyboardListener(self, listener)
selectAll(self)
setCursorPos(self, pos)
setKey(self, key)
setName(self, name)
setSelectionRange(self, pos, length)
setText(self, text)
setTextAlignment(self, align)
Data and other attributes inherited from TextBoxBase:
ALIGN_CENTER = 'center'
ALIGN_JUSTIFY = 'justify'
ALIGN_LEFT = 'left'
ALIGN_RIGHT = 'right'
Methods inherited from FocusWidget:
addFocusListener(self, listener)
getTabIndex(self)
isEnabled(self)
removeFocusListener(self, listener)
setAccessKey(self, key)
setEnabled(self, enabled)
setFocus(self, focused)
setTabIndex(self, index)
Methods inherited from Widget:
getID(self)
Get the id attribute of the associated DOM element.
getLayoutData(self)
getParent(self)
Widgets are kept in a hierarchy, and widgets that have been added to a panel
will have a parent widget that contains them.  This retrieves the containing
widget for this widget.
isAttached(self)
Return whether or not this widget has been attached to the document.
onAttach(self)
Called when this widget has an element, and that element is on the document's
DOM tree, and we have a parent widget.
onDetach(self)
Called when this widget is being removed from the DOM tree of the document.
onLoad(self, sender)
removeFromParent(self)
Remove ourself from our parent.  The parent widget will call setParent(None) on
us automatically
setID(self, id)
Set the id attribute of the associated DOM element.
setLayoutData(self, layoutData)
setParent(self, parent)
Update the parent attribute.  If the parent is currently attached to the DOM this
assumes we are being attached also and calls onAttach().
Methods inherited from UIObject:
addStyleName(self, style)
Append a style to the element associated with this UIObject.  This is
a CSS class name.  It will be added after any already-assigned CSS class for
the element.
getAbsoluteLeft(self)
getAbsoluteTop(self)
getElement(self)
Get the DOM element associated with the UIObject, if any
getOffsetHeight(self)
getOffsetWidth(self)
getStyleName(self)
getTitle(self)
isVisible(self, element=None)
Determine whether this element is currently visible, by checking the CSS
property 'display'
removeStyleName(self, style)
Remove a style from the element associated with this UIObject.  This is
a CSS class name.
setElement(self, element)
Set the DOM element associated with the UIObject.
setHeight(self, height)
Set the height of the element associated with this UIObject.  The
value should be given as a CSS value, such as 100px, 30%, or 50pi
setPixelSize(self, width, height)
Set the width and height of the element associated with this UIObject
in pixels.  Width and height should be numbers.
setSize(self, width, height)
Set the width and height of the element associated with this UIObject.  The
values should be given as a CSS value, such as 100px, 30%, or 50pi
setStyleName(self, element, style=None, add=True)
When called with a single argument, this replaces all the CSS classes
associated with this UIObject's element with the given parameter.  Otherwise,
this is assumed to be a worker function for addStyleName and removeStyleName.
setTitle(self, title)
setVisible(self, element, visible=None)
Set whether this element is visible or not.  If a single parameter is
given, the self.element is used.  This modifies the CSS property 'display',
which means that an invisible element not only is not drawn, but doesn't
occupy any space on the page.
setWidth(self, width)
Set the width of the element associated with this UIObject.  The
value should be given as a CSS value, such as 100px, 30%, or 50pi
setzIndex(self, index)
sinkEvents(self, eventBitsToAdd)
Request that the given events be delivered to the event handler for this
element.  The event bits passed are added (using inclusive OR) to the events
already "sunk" for the element associated with the UIObject.  The event bits
are a combination of values from class L{Event}.
unsinkEvents(self, eventBitsToRemove)
Reverse the operation of sinkEvents.  See L{UIObject.sinkEvents}.
''', 'FlexTable': r'''

 
class FlexTable(HTMLTable)
    FlexTable can create cells on demand. It can be jagged
(that is, each row can contain a different number of cells)
and individual cells can be set to span multiple rows or columns.
 
 
Method resolution order:
FlexTable
HTMLTable
Panel
Widget
UIObject
Methods defined here:
__init__(self)
addCell(self, row)
addCells(self, table, row, num)
getCellCount(self, row)
getFlexCellFormatter(self)
getRowCount(self)
prepareCell(self, row, column)
prepareRow(self, row)
removeCells(self, row, column, num)
Methods inherited from HTMLTable:
__iter__(self)
addTableListener(self, listener)
checkCellBounds(self, row, column)
checkRowBounds(self, row)
cleanCell(self, row, column)
clear(self)
clearCell(self, row, column)
computeKey(self, row, column)
computeKeyForElement(self, widgetElement)
createCell(self)
getBodyElement(self)
getCellFormatter(self)
getCellPadding(self)
getCellSpacing(self)
getDOMCellCount(self, element, row=None)
# also callable as getDOMCellCount(row)
getDOMCellCountImpl(self, element, row)
getDOMRowCount(self, element=None)
# also callable as getDOMRowCount(element)
getDOMRowCountImpl(self, element)
getEventTargetCell(self, event)
getHTML(self, row, column)
getRowFormatter(self)
getText(self, row, column)
getWidget(self, row, column=None)
# also callable as getWidget(widgetElement)
insertCell(self, row, column)
insertCells(self, row, column, count)
insertRow(self, beforeRow)
internalClearCell(self, td)
isCellPresent(self, row, column)
onBrowserEvent(self, event)
remove(self, widget)
removeCell(self, row, column)
removeRow(self, row)
removeTableListener(self, listener)
removeWidget(self, widget)
setBorderWidth(self, width)
setCellFormatter(self, cellFormatter)
setCellPadding(self, padding)
setCellSpacing(self, spacing)
setHTML(self, row, column, html)
setRowFormatter(self, rowFormatter)
setText(self, row, column, text)
setWidget(self, row, column, widget)
Methods inherited from Panel:
add(self)
adopt(self, widget, container)
disown(self, widget)
onAttach(self)
onDetach(self)
Methods inherited from Widget:
getID(self)
Get the id attribute of the associated DOM element.
getLayoutData(self)
getParent(self)
Widgets are kept in a hierarchy, and widgets that have been added to a panel
will have a parent widget that contains them.  This retrieves the containing
widget for this widget.
isAttached(self)
Return whether or not this widget has been attached to the document.
onLoad(self, sender)
removeFromParent(self)
Remove ourself from our parent.  The parent widget will call setParent(None) on
us automatically
setID(self, id)
Set the id attribute of the associated DOM element.
setLayoutData(self, layoutData)
setParent(self, parent)
Update the parent attribute.  If the parent is currently attached to the DOM this
assumes we are being attached also and calls onAttach().
Methods inherited from UIObject:
addStyleName(self, style)
Append a style to the element associated with this UIObject.  This is
a CSS class name.  It will be added after any already-assigned CSS class for
the element.
getAbsoluteLeft(self)
getAbsoluteTop(self)
getElement(self)
Get the DOM element associated with the UIObject, if any
getOffsetHeight(self)
getOffsetWidth(self)
getStyleName(self)
getTitle(self)
isVisible(self, element=None)
Determine whether this element is currently visible, by checking the CSS
property 'display'
removeStyleName(self, style)
Remove a style from the element associated with this UIObject.  This is
a CSS class name.
setElement(self, element)
Set the DOM element associated with the UIObject.
setHeight(self, height)
Set the height of the element associated with this UIObject.  The
value should be given as a CSS value, such as 100px, 30%, or 50pi
setPixelSize(self, width, height)
Set the width and height of the element associated with this UIObject
in pixels.  Width and height should be numbers.
setSize(self, width, height)
Set the width and height of the element associated with this UIObject.  The
values should be given as a CSS value, such as 100px, 30%, or 50pi
setStyleName(self, element, style=None, add=True)
When called with a single argument, this replaces all the CSS classes
associated with this UIObject's element with the given parameter.  Otherwise,
this is assumed to be a worker function for addStyleName and removeStyleName.
setTitle(self, title)
setVisible(self, element, visible=None)
Set whether this element is visible or not.  If a single parameter is
given, the self.element is used.  This modifies the CSS property 'display',
which means that an invisible element not only is not drawn, but doesn't
occupy any space on the page.
setWidth(self, width)
Set the width of the element associated with this UIObject.  The
value should be given as a CSS value, such as 100px, 30%, or 50pi
setzIndex(self, index)
sinkEvents(self, eventBitsToAdd)
Request that the given events be delivered to the event handler for this
element.  The event bits passed are added (using inclusive OR) to the events
already "sunk" for the element associated with the UIObject.  The event bits
are a combination of values from class L{Event}.
unsinkEvents(self, eventBitsToRemove)
Reverse the operation of sinkEvents.  See L{UIObject.sinkEvents}.
''', 'CellFormatter': r'''

 
class CellFormatter
    CellFormatter is a class for managing formatting of cells in
various types of Panel classes, such as HTMLTable and Grid.
These Panel classes typically use CellFormatter automatically
on your behalf, although you can over-ride that to use your
own CellFormatter class.
 
  Methods defined here:
__init__(self, outer)
addStyleName(self, row, column, styleName)
ensureElement(self, row, column)
getAttr(self, row, column, attr)
getCellElement(self, table, row, col)
getElement(self, row, column)
getRawElement(self, row, column)
getStyleName(self, row, column)
isVisible(self, row, column)
removeStyleName(self, row, column, styleName)
setAlignment(self, row, column, hAlign, vAlign)
setAttr(self, row, column, attrName, value)
setHeight(self, row, column, height)
setHorizontalAlignment(self, row, column, align)
setStyleName(self, row, column, styleName)
setVerticalAlignment(self, row, column, align)
setVisible(self, row, column, visible)
setWidth(self, row, column, width)
setWordWrap(self, row, column, wrap)
''', 'LayoutData': r'''

 
class LayoutData
     Methods defined here:
__init__(self, direction)
''', 'HasVerticalAlignment': r'''

 
class HasVerticalAlignment
     Data and other attributes defined here:
ALIGN_BOTTOM = 'bottom'
ALIGN_MIDDLE = 'middle'
ALIGN_TOP = 'top'
''', 'Frame': r'''

 
class Frame(Widget)
    A widget that wraps an IFRAME element, which can contain an
arbitrary web site.
 
Note that if you are using History, any browser history items
generated by the Frame will interleave with your application's history.
 
 
Method resolution order:
Frame
Widget
UIObject
Methods defined here:
__init__(self, url='')
getUrl(self)
setUrl(self, url)
Methods inherited from Widget:
getID(self)
Get the id attribute of the associated DOM element.
getLayoutData(self)
getParent(self)
Widgets are kept in a hierarchy, and widgets that have been added to a panel
will have a parent widget that contains them.  This retrieves the containing
widget for this widget.
isAttached(self)
Return whether or not this widget has been attached to the document.
onAttach(self)
Called when this widget has an element, and that element is on the document's
DOM tree, and we have a parent widget.
onBrowserEvent(self, event)
onDetach(self)
Called when this widget is being removed from the DOM tree of the document.
onLoad(self, sender)
removeFromParent(self)
Remove ourself from our parent.  The parent widget will call setParent(None) on
us automatically
setID(self, id)
Set the id attribute of the associated DOM element.
setLayoutData(self, layoutData)
setParent(self, parent)
Update the parent attribute.  If the parent is currently attached to the DOM this
assumes we are being attached also and calls onAttach().
Methods inherited from UIObject:
addStyleName(self, style)
Append a style to the element associated with this UIObject.  This is
a CSS class name.  It will be added after any already-assigned CSS class for
the element.
getAbsoluteLeft(self)
getAbsoluteTop(self)
getElement(self)
Get the DOM element associated with the UIObject, if any
getOffsetHeight(self)
getOffsetWidth(self)
getStyleName(self)
getTitle(self)
isVisible(self, element=None)
Determine whether this element is currently visible, by checking the CSS
property 'display'
removeStyleName(self, style)
Remove a style from the element associated with this UIObject.  This is
a CSS class name.
setElement(self, element)
Set the DOM element associated with the UIObject.
setHeight(self, height)
Set the height of the element associated with this UIObject.  The
value should be given as a CSS value, such as 100px, 30%, or 50pi
setPixelSize(self, width, height)
Set the width and height of the element associated with this UIObject
in pixels.  Width and height should be numbers.
setSize(self, width, height)
Set the width and height of the element associated with this UIObject.  The
values should be given as a CSS value, such as 100px, 30%, or 50pi
setStyleName(self, element, style=None, add=True)
When called with a single argument, this replaces all the CSS classes
associated with this UIObject's element with the given parameter.  Otherwise,
this is assumed to be a worker function for addStyleName and removeStyleName.
setTitle(self, title)
setVisible(self, element, visible=None)
Set whether this element is visible or not.  If a single parameter is
given, the self.element is used.  This modifies the CSS property 'display',
which means that an invisible element not only is not drawn, but doesn't
occupy any space on the page.
setWidth(self, width)
Set the width of the element associated with this UIObject.  The
value should be given as a CSS value, such as 100px, 30%, or 50pi
setzIndex(self, index)
sinkEvents(self, eventBitsToAdd)
Request that the given events be delivered to the event handler for this
element.  The event bits passed are added (using inclusive OR) to the events
already "sunk" for the element associated with the UIObject.  The event bits
are a combination of values from class L{Event}.
unsinkEvents(self, eventBitsToRemove)
Reverse the operation of sinkEvents.  See L{UIObject.sinkEvents}.
''', 'MouseListener': r'''

 
class MouseListener
    # MouseListenerCollection
 
  Methods defined here:
fireMouseEvent(self, listeners, sender, event)
''', 'Focus': r'''

 
class Focus
    # FocusImpl
 
  Methods defined here:
blur(self, elem)
createFocusable(self)
focus(self, elem)
getTabIndex(self, elem)
setAccessKey(self, elem, key)
setTabIndex(self, elem, index)
''', 'EventObject': r'''

 
class EventObject
     Methods defined here:
__init__(self, source)
getSource(self)
''', 'TreeContentPanel': r'''

 
class TreeContentPanel(SimplePanel)
    
Method resolution order:
TreeContentPanel
SimplePanel
Panel
Widget
UIObject
Methods defined here:
__init__(self, element)
getTreeItem(self)
setParent(self, widget)
setTreeItem(self, tree_item)
treeSetParent(self, widget)
Methods inherited from SimplePanel:
add(self, widget)
getContainerElement(self)
getWidget(self)
remove(self, widget)
setWidget(self, widget)
Methods inherited from Panel:
__iter__(self)
adopt(self, widget, container)
clear(self)
# TODO: fix iterator remove()
disown(self, widget)
onAttach(self)
onDetach(self)
Methods inherited from Widget:
getID(self)
Get the id attribute of the associated DOM element.
getLayoutData(self)
getParent(self)
Widgets are kept in a hierarchy, and widgets that have been added to a panel
will have a parent widget that contains them.  This retrieves the containing
widget for this widget.
isAttached(self)
Return whether or not this widget has been attached to the document.
onBrowserEvent(self, event)
onLoad(self, sender)
removeFromParent(self)
Remove ourself from our parent.  The parent widget will call setParent(None) on
us automatically
setID(self, id)
Set the id attribute of the associated DOM element.
setLayoutData(self, layoutData)
Methods inherited from UIObject:
addStyleName(self, style)
Append a style to the element associated with this UIObject.  This is
a CSS class name.  It will be added after any already-assigned CSS class fo