HappyDoc Generated Documentation Class: pwSelectInput

widget.py / pwSelectInput 

Selector widget class
Widget to display selectors that users can use to select from one (or more) of multiple values. Note that the constructor to the selector widget takes a list of tuples where the tuples contain value:text pairs. The reason for using tuples is that if we use a dictionary the order is random and the user may want a specific order

Arguments:

  • obj: the object that contains the attribute associated with this field
  • attr: the name of the attribute
  • selList: the list of items to select from, organized as a list of tuples, where each tuple contains a name,value pair. The name portion will be displayed and the value portion will be passwd on selection

Common Keywords:

  • divClass: allows the user to override the class of the
  • fieldSpecial: allows the user to add "special" HTML attributes to the output element
  • id: overrides the HTML "id" attribute
  • selectable: controls whether this field is selectable or not
  • inputType: mostly for internal use -- overrides the type designation in the output hidden fields

Keywords:

  • multiple: if "true", this is a multiple selector rather then a single selector
  • header: if present, this is a header to be displayed above the selector
  • size: if a multiple selector, how many items should be displayed
  • hiddenFields: if "false" do not include hiddenFields for this selector
  • onclick: a javascript action to perform when a selection is made

Default divClass: pwSelector

Base Classes   

pwSelectInput
  pyWidget

Methods   
  display 
display ( self,  lvl )
  __init__ 
__init__ (
        self,
        obj,
        attr,
        selList,
        **kwlist,
        )
Exceptions   

NoSuchAttribute


This document was automatically generated Tue Sep 21 18:50:52 2004 by HappyDoc version 3.0.a1