Back to index

python-weblib  1.3.9
Public Member Functions | Public Attributes
pyweblib.forms.Checkbox Class Reference
Inheritance diagram for pyweblib.forms.Checkbox:
Inheritance graph
[legend]
Collaboration diagram for pyweblib.forms.Checkbox:
Collaboration graph
[legend]

List of all members.

Public Member Functions

def __init__
def inputHTML
def idAttrStr
def labelHTML
def getValue
def setDefault
def setRegex
def setValue
def setCharset
def titleHTML
def valueHTML

Public Attributes

 checked
 value
 name
 text
 maxLen
 maxValues
 required
 accessKey
 inputHTMLTemplate
 valueHTMLTemplate
 charset
 default

Detailed Description

Check boxes:
<INPUT TYPE=CHECKBOX>

Definition at line 581 of file forms.py.


Constructor & Destructor Documentation

def pyweblib.forms.Checkbox.__init__ (   self,
  name,
  text,
  maxValues = 1,
  required = 0,
  accessKey = '',
  default = None,
  checked = 0 
)
pattern and maxLen are determined by default

Definition at line 590 of file forms.py.

00590 
00591   ):
00592     """
00593     pattern and maxLen are determined by default
00594     """
00595     pattern = default
00596     maxLen = len(default or '')
00597     self.checked = checked
00598     Field.__init__(
00599       self,name,text,maxLen,maxValues,pattern,required,default,accessKey
00600     )


Member Function Documentation

def pyweblib.forms.Field.getValue (   self) [inherited]
Returns self.value in case of multi-valued input or
self.value[0] if only one value is allowed.

Definition at line 103 of file forms.py.

00103 
00104   def getValue(self):
00105     """
00106     Returns self.value in case of multi-valued input or
00107     self.value[0] if only one value is allowed.
00108     """
00109     if self.maxValues>1:
00110       return self.value
00111     else:
00112       return self.value[0]

def pyweblib.forms.Field.idAttrStr (   self,
  id_value 
) [inherited]

Definition at line 93 of file forms.py.

00093 
00094   def idAttrStr(self,id_value):
00095     if id_value is None:
00096       return ''
00097     else:
00098       return 'id="%s" ' % (id_value)

Here is the caller graph for this function:

def pyweblib.forms.Checkbox.inputHTML (   self,
  default = None,
  id_value = None,
  title = None,
  checked = None 
)

Definition at line 601 of file forms.py.

00601 
00602   def inputHTML(self,default=None,id_value=None,title=None,checked=None):
00603     if checked is None:
00604       checked = self.checked
00605     return self.inputHTMLTemplate % (
00606       '<input type="checkbox" %stitle="%s" name="%s" %s value="%s"%s>' % (
00607         self.idAttrStr(id_value),
00608         self.titleHTML(title),
00609         self.name,
00610         self._accessKeyAttr(),
00611         self._defaultValue(default),' checked'*(checked)
00612       )
00613     )
00614 

Here is the call graph for this function:

def pyweblib.forms.Field.labelHTML (   self,
  labelText = None,
  for_value = None 
) [inherited]

Definition at line 99 of file forms.py.

00099 
00100   def labelHTML(self,labelText=None,for_value=None):
00101     labelText = (labelText or self.text).encode(self.charset)
00102     return '<label for="%s">%s</label>' % (for_value or self.name,labelText)

def pyweblib.forms.Field.setCharset (   self,
  charset 
) [inherited]
Define the character set of the user's input.

Definition at line 212 of file forms.py.

00212 
00213   def setCharset(self,charset):
00214     """Define the character set of the user's input."""
00215     self.charset = charset

def pyweblib.forms.Field.setDefault (   self,
  default 
) [inherited]
Set the default of a field.

Mainly this is used by the application if self.default shall
be changed after initializing the field object.

Reimplemented in pyweblib.forms.Radio.

Definition at line 113 of file forms.py.

00113 
00114   def setDefault(self,default):
00115     """
00116     Set the default of a field.
00117 
00118     Mainly this is used by the application if self.default shall
00119     be changed after initializing the field object.
00120     """
00121     if type(default)==types.ListType:
00122       self.default = [i for i in default if i!=None]
00123     else:
00124       self.default = default or ''

Here is the caller graph for this function:

def pyweblib.forms.Field.setRegex (   self,
  pattern 
) [inherited]
Set the regex pattern for validating this field.

Mainly this is used if self._re shall be changed after
the field object was initialized.

pattern
Either a string containing a regex pattern,
a tuple (pattern string, pattern options) or None.
If None regex checking in _validateFormat is switched off
(not recommended).

Reimplemented in pyweblib.forms.Textarea.

Definition at line 138 of file forms.py.

00138 
00139   def setRegex(self,pattern):
00140     """
00141     Set the regex pattern for validating this field.
00142 
00143     Mainly this is used if self._re shall be changed after
00144     the field object was initialized.
00145 
00146     pattern
00147         Either a string containing a regex pattern,
00148         a tuple (pattern string, pattern options) or None.
00149         If None regex checking in _validateFormat is switched off
00150         (not recommended).
00151     """
00152     patternstring,patternoptions = self._patternAndOptions(pattern)
00153     if patternstring is None:
00154       # Regex checking is completely switched off
00155       self._re = None
00156     else:
00157       # This is a Unicode input field
00158       patternoptions = patternoptions | re.U
00159       self._re = re.compile('%s$' % patternstring,patternoptions)

Here is the call graph for this function:

def pyweblib.forms.Field.setValue (   self,
  value 
) [inherited]
Store the user's value into the field object.

This method can be used to modify the user's value
before storing it into self.value.

Definition at line 196 of file forms.py.

00196 
00197   def setValue(self,value):
00198     """
00199     Store the user's value into the field object.
00200 
00201     This method can be used to modify the user's value
00202     before storing it into self.value.
00203     """
00204     value = self._encodeValue(value)
00205     # Check if input is valid
00206     # Length valid?
00207     self._validateLen(value)
00208     # Format valid?
00209     self._validateFormat(value)
00210     self._validateMaxValue()
00211     self.value.append(value)

Here is the call graph for this function:

def pyweblib.forms.Field.titleHTML (   self,
  title 
) [inherited]
HTML output of default.

Definition at line 220 of file forms.py.

00220 
00221   def titleHTML(self,title):
00222     """HTML output of default."""
00223     return escapeHTML(title or self.text).encode(self.charset)

Here is the call graph for this function:

Here is the caller graph for this function:

def pyweblib.forms.Field.valueHTML (   self) [inherited]
HTML output of self.value using the HTML template string
in self.valueHTMLTemplate.

Reimplemented in pyweblib.forms.Keygen, pyweblib.forms.Password, and pyweblib.forms.Textarea.

Definition at line 228 of file forms.py.

00228 
00229   def valueHTML(self):
00230     """
00231     HTML output of self.value using the HTML template string
00232     in self.valueHTMLTemplate.
00233     """
00234     return [
00235       self.valueHTMLTemplate % v
00236       for v in self.value
00237     ]
00238 


Member Data Documentation

Definition at line 78 of file forms.py.

Definition at line 83 of file forms.py.

Definition at line 596 of file forms.py.

Reimplemented in pyweblib.forms.Radio.

Definition at line 121 of file forms.py.

Definition at line 79 of file forms.py.

Reimplemented in pyweblib.forms.Radio.

Definition at line 75 of file forms.py.

Definition at line 76 of file forms.py.

Definition at line 73 of file forms.py.

Definition at line 77 of file forms.py.

Definition at line 74 of file forms.py.

Definition at line 72 of file forms.py.

Definition at line 80 of file forms.py.


The documentation for this class was generated from the following file: