Docs for DIV

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

Description


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




















HTML helper, for easy generating and manipulating a DOM structure.
Little or no validation is done.

Behaves like a dictionary regarding updating of attributes.
Behaves like a list regarding inserting/appending components.

example::

>>>
DIV('hello', 'world', _style='color:red;').xml()
'<div style="color:red;">helloworld</div>'

all other HTML helpers are derived from DIV.

_something="value" attributes are transparently translated into
something="value" HTML attributes


Attributes


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

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

DIV.__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

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

DIV.__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.

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

DIV.__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

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

DIV.__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

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

DIV.__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.

DIV.__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

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

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

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

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

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

DIV.__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

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

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

DIV._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.

DIV._postprocessing <type 'instancemethod'> belongs to class <type 'instancemethod'>
Handling of attributes (normally the ones not prefixed with '_'). Nothing to postprocess yet. May be overridden by subclasses

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

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

DIV._validate <type 'instancemethod'> belongs to class <type 'instancemethod'>
nothing to validate yet. May be overridden by subclasses

DIV._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

DIV._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 and the name will be in lower case. A value of True is replaced with the attribute name. :returns: tuple: (attributes, components)

DIV.append <type 'instancemethod'> belongs to class <type 'instancemethod'>
list style appending of components

DIV.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.

DIV.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.

DIV.insert <type 'instancemethod'> belongs to class <type 'instancemethod'>
list style inserting of components

DIV.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

DIV.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

DIV.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.

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

DIV.xml <type 'instancemethod'> belongs to class <type 'instancemethod'>
generates the xml for this component.