Docs for INPUT

[ Python Tutorial ] [ Python Libraries ] [ web2py epydoc ]

Description

<type 'type'> extends (<class 'gluon.html.DIV'>,)


        INPUT Component

        examples::

            >>> INPUT(_type='text', _name='name', value='Max').xml()
            '<input name="name" type="text" value="Max" />'

            >>> INPUT(_type='checkbox', _name='checkbox', value='on').xml()
            '<input checked="checked" name="checkbox" type="checkbox" value="on" />'

            >>> INPUT(_type='radio', _name='radio', _value='yes', value='yes').xml()
            '<input checked="checked" name="radio" type="radio" value="yes" />'

            >>> INPUT(_type='radio', _name='radio', _value='no', value='yes').xml()
            '<input name="radio" type="radio" value="no" />'

        the input helper takes two special attributes value= and requires=.

        :param value: used to pass the initial value for the input field.
            value differs from _value because it works for checkboxes, radio,
            textarea and select/option too.

            - for a checkbox value should be '' or 'on'.
            - for a radio or select/option value should be the _value
                of the checked/selected item.

        :param requires: should be None, or a validator or a list of validators
            for the value of the field.

Attributes


INPUT.__class__	<type 'type'> extends (<type 'object'>,) belongs to class <type 'type'> type(object) -> the object's type type(name, bases, dict) -> a new type

INPUT.__delattr__	<type 'wrapper_descriptor'> belongs to class <type 'wrapper_descriptor'> x.__delattr__('name') <==> del x.name

INPUT.__delitem__	<type 'instancemethod'> belongs to class <type 'instancemethod'> deletes attribute with name 'i' or component #i. :param i: index if i is a string: the name of the attribute otherwise references to number of the component

INPUT.__dict__	<type 'dictproxy'> belongs to class <type 'dictproxy'>

INPUT.__doc__	<type 'str'> belongs to class <type 'str'> str(object) -> string Return a nice string representation of the object. If the argument is a string, the return value is the same object.

INPUT.__getattribute__	<type 'wrapper_descriptor'> belongs to class <type 'wrapper_descriptor'> x.__getattribute__('name') <==> x.name

INPUT.__getitem__	<type 'instancemethod'> belongs to class <type 'instancemethod'> gets attribute with name 'i' or component #i. If attribute 'i' is not found returns None :param i: index if i is a string: the name of the attribute otherwise references to number of the component

INPUT.__hash__	<type 'wrapper_descriptor'> belongs to class <type 'wrapper_descriptor'> x.__hash__() <==> hash(x)

INPUT.__init__	<type 'instancemethod'> belongs to class <type 'instancemethod'> :param components: any components that should be nested in this element :param *attributes: any attributes you want to give to this element :raises SyntaxError: when a stand alone tag receives components

INPUT.__len__	<type 'instancemethod'> belongs to class <type 'instancemethod'> returns the number of included components

INPUT.__module__	<type 'str'> belongs to class <type 'str'> str(object) -> string Return a nice string representation of the object. If the argument is a string, the return value is the same object.

INPUT.__new__	<type 'builtin_function_or_method'> belongs to class <type 'builtin_function_or_method'> T.__new__(S, ...) -> a new object with type S, a subtype of T

INPUT.__nonzero__	<type 'instancemethod'> belongs to class <type 'instancemethod'> always return True

INPUT.__reduce__	<type 'method_descriptor'> belongs to class <type 'method_descriptor'> helper for pickle

INPUT.__reduce_ex__	<type 'method_descriptor'> belongs to class <type 'method_descriptor'> helper for pickle

INPUT.__repr__	<type 'wrapper_descriptor'> belongs to class <type 'wrapper_descriptor'> x.__repr__() <==> repr(x)

INPUT.__setattr__	<type 'wrapper_descriptor'> belongs to class <type 'wrapper_descriptor'> x.__setattr__('name', value) <==> x.name = value

INPUT.__setitem__	<type 'instancemethod'> belongs to class <type 'instancemethod'> sets attribute with name 'i' or component #i. :param i: index if i is a string: the name of the attribute otherwise references to number of the component :param value: the new value

INPUT.__str__	<type 'instancemethod'> belongs to class <type 'instancemethod'> str(COMPONENT) returns equals COMPONENT.xml()

INPUT.__weakref__	<type 'getset_descriptor'> belongs to class <type 'getset_descriptor'> list of weak references to the object (if defined)

INPUT._fixup	<type 'instancemethod'> belongs to class <type 'instancemethod'> Handling of provided components. Nothing to fixup yet. May be overridden by subclasses, eg for wrapping some components in another component or blocking them.

INPUT._postprocessing	<type 'instancemethod'> belongs to class <type 'instancemethod'>

INPUT._setnode	<type 'instancemethod'> belongs to class <type 'instancemethod'>

INPUT._traverse	<type 'instancemethod'> belongs to class <type 'instancemethod'>

INPUT._validate	<type 'instancemethod'> belongs to class <type 'instancemethod'>

INPUT._wrap_components	<type 'instancemethod'> belongs to class <type 'instancemethod'> helper for _fixup. Checks if a component is in allowed_parents, otherwise wraps it in wrap_parent :param allowed_parents: (tuple) classes that the component should be an instance of :param wrap_parent: the class to wrap the component in, if needed :param wrap_lambda: lambda to use for wrapping, if needed

INPUT._xml	<type 'instancemethod'> belongs to class <type 'instancemethod'> helper for xml generation. Returns separately: - the component attributes - the generated xml of the inner components Component attributes start with an underscore ('_') and do not have a False or None value. The underscore is removed. A value of True is replaced with the attribute name. :returns: tuple: (attributes, components)

INPUT.append	<type 'instancemethod'> belongs to class <type 'instancemethod'> list style appending of components >>> a=DIV() >>> a.append(SPAN('x')) >>> print a <div><span>x</span></div>

INPUT.element	<type 'instancemethod'> belongs to class <type 'instancemethod'> find the first component that matches the supplied attribute dictionary, or None if nothing could be found Also the components of the components are searched.

INPUT.elements	<type 'instancemethod'> belongs to class <type 'instancemethod'> find all component that match the supplied attribute dictionary, or None if nothing could be found All components of the components are searched. >>> a = DIV(DIV(SPAN('x'),3,DIV(SPAN('y')))) >>> for c in a.elements('span',first_only=True): c[0]='z' >>> print a <div><div><span>z</span>3<div><span>y</span></div></div></div> >>> for c in a.elements('span'): c[0]='z' >>> print a <div><div><span>z</span>3<div><span>z</span></div></div></div> It also supports a syntax compatible with jQuery >>> a=TAG('<div><span><a id="1-1" u:v=$>hello</a></span><p class="this is a test">world</p></div>') >>> for e in a.elements('div a#1-1, p.is'): print e.flatten() hello world >>> for e in a.elements('#1-1'): print e.flatten() hello >>> a.elements('a[u:v=$]')[0].xml() '<a id="1-1" u:v="$">hello</a>' >>> a=FORM( INPUT(_type='text'), SELECT(range(1)), TEXTAREA() ) >>> for c in a.elements('input, select, textarea'): c['_disabled'] = 'disabled' >>> a.xml() '<form action="" enctype="multipart/form-data" method="post"><input disabled="disabled" type="text" /><select disabled="disabled"><option value="0">0</option></select><textarea cols="40" disabled="disabled" rows="10"></textarea></form>'

INPUT.flatten	<type 'instancemethod'> belongs to class <type 'instancemethod'> return the text stored by the DIV object rendered by the render function the render function must take text, tagname, and attributes render=None is equivalent to render=lambda text, tag, attr: text >>> markdown = lambda text,tag=None,attributes={}: {None: re.sub('\s+',' ',text), 'h1':'#'+text+'\n\n', 'p':text+'\n'}.get(tag,text) >>> a=TAG('<h1>Header</h1><p>this is a test</p>') >>> a.flatten(markdown) '#Header\n\nthis is a test\n'

INPUT.insert	<type 'instancemethod'> belongs to class <type 'instancemethod'> list style inserting of components >>> a=DIV() >>> a.insert(0,SPAN('x')) >>> print a <div><span>x</span></div>

INPUT.regex_attr	<type '_sre.SRE_Pattern'> Compiled regular expression objects

INPUT.regex_class	<type '_sre.SRE_Pattern'> Compiled regular expression objects

INPUT.regex_id	<type '_sre.SRE_Pattern'> Compiled regular expression objects

INPUT.regex_tag	<type '_sre.SRE_Pattern'> Compiled regular expression objects

INPUT.sibling	<type 'instancemethod'> belongs to class <type 'instancemethod'> find the first sibling component that match the supplied argument list and attribute dictionary, or None if nothing could be found

INPUT.siblings	<type 'instancemethod'> belongs to class <type 'instancemethod'> find all sibling components that match the supplied argument list and attribute dictionary, or None if nothing could be found

INPUT.tag	<type 'str'> belongs to class <type 'str'> str(object) -> string Return a nice string representation of the object. If the argument is a string, the return value is the same object.

INPUT.update	<type 'instancemethod'> belongs to class <type 'instancemethod'> dictionary like updating of the tag attributes

INPUT.xml	<type 'instancemethod'> belongs to class <type 'instancemethod'>