gnue.forms Private API - GNU Enterprise

Package gnue :: Package forms :: Package GFObjects :: Module GFPage :: Class GFPage

[show private | hide private]

Type GFPage

 GTriggerCore --+            
                |            
   object --+   |            
            |   |            
    ParserObj --+            
                |            
             GObj --+        
                    |        
GTriggerExtension --+        
                    |        
                GFObj --+    
                        |    
              GFContainer --+
                            |
                           GFPage

Implementation of the <page> tag

Method Summary
	`__init__(self, parent)`
	`_phase_1_init_(self)` On phase 1 initialization a logical page registers itself at the logic object.
	`focus_in(self)` Notify the entry that it has received the focus.
	`focus_out(self)` Notify the entry that it is going to lose the focus.
	`rearrange_boxes(self)` Calculate the bounding boxes of all GFBox items per page and reparent all children which fit into such a GFBox.
	`validate(self)` Validate the entry to decide whether the focus can be moved away from it.
Inherited from GFContainer
	`get_focus_order(self, list)` Builds a list of objects ordered in the way in which they should receive focus.
Inherited from GFObj
	`_is_navigable_(self, mode)` Return wether the object is currently navigable or not.
	`get_block(self)` Return the objects' block from the block mapping.
	`get_field(self)` Returns the objects' field from the blocks' field mapping
	`get_option(self, name)` Return the value of a given option of the object or None if no such option is present.
	`is_navigable(self, mode)` Return wether the object is currently navigable or not.
	`phase_1_init(self)` Phase 1 initialization called after all objects of the XML tree were created.
Inherited from GObj
	`__getitem__(self, key)`
	`__setitem__(self, key, value)`
	`_dumpXML_(self, lookupDict, treeDump, gap, xmlnamespaces, textEncoding, stripPrefixes, escape)` Dumps an XML representation of the object
	`buildAndInitObject(self, **params)` This is a convenience function for applications NOT using GParser to load an object tree.
	`buildObject(self, **params)` A convenience function for applications NOT using GParser to load an object tree.
string	`getXmlTag(self, stripPrefixes)` Returns the xml tag to be used to represent the object.
	`iterator(self, test, types, includeSelf)` Return a python iterator of child objects.
	`maxInits(self)` maxInits returns the maximum size of all the _inits list from this object or it's children
	`phaseInit(self, iterations)` Starts GNUe's phased initialization system from this object down.
	`showTree(self, indent)` A recusive function to print an indented text representation of the GObj tree from this object down.
	`walk(self, function, args, *parms)` Function that recursively walks down through a tree of `ParserObj` instances and applies a function to them.
	`_buildObject(self)` This function is called after the parsers have completely constructed.
	`_phaseInit(self, phase)` Used internally by phaseInit to walk through the object tree initializing objects.
	`_setItemHook(self, key, value)` This bit of nastiness is here to let GNUe Designer capture the setting of GObject properties.
Inherited from GTriggerCore
	`__repr__(self)`
	`create_namespace_object(self, global_namespace, namespace_name)` Construct a namespace object tree from an XML (`definitions.GObjects.GObj`) object tree.
	`get_namespace_object(self)` Return the namespace object that mirrors this object in the action/trigger namespace.
Inherited from ParserObj
	`_diffActionWalker_(self, obj, action)` Set the action attribute of a given object to the specified action.
	`_getAsContents_(self)` Get the contents of this object.
	`_id_(self, maxIdLength)` Return a compareable and identifying id of an object within a tree.
	`_set_initial_attributes_(self, attributes)` Set attributes loaded by GParser.
	`addChild(self, child)` Add an object to the list of children
	`assign(self, source, recursive)` Assign all attributes from a given object to this one.
	`diff(self, goal, maxIdLength)` Build an object tree representing the difference between two object trees.
	`dumpXML(self, lookupDict, treeDump, gap, xmlnamespaces, textEncoding, stripPrefixes, escape)` Return a XML representation of the object.
	`findChildNamed(self, name, childType)` Moves downward though the children of an object till it finds the child with the specified name.
	`findChildOfType(self, childType, includeSelf, allowAllChildren)` Moves downward through the children of an object till it finds the child of the specified type.
	`findChildrenOfType(self, childType, includeSelf, allowAllChildren)` Find all children of a specific type.
	`findParentOfType(self, parentType, includeSelf)` Moves upward though the parents of an object till it finds the parent of the specified type.
	`getChildrenAsContent(self)` Returns the content of any GContent objects that are children of this object.
	`getDescription(self)` Return a useful description of the object.
any	`getParent(self)` Returns the immediate parent of an object instance in a GObj tree.
	`merge(self, other, maxIdLength, overwrite)` Merge another object tree into this tree.
	`setParent(self, newParent)` Set the immediate parent of an object instance in a GObj tree
Inherited from object
	`__delattr__(...)` x.__delattr__('name') <==> del x.name
	`__getattribute__(...)` x.__getattribute__('name') <==> x.name
	`__hash__(x)` Return hash(x)...
	`__new__(T, S, ...)` Return a new object with type S, a subtype of T...
	`__reduce__(...)` helper for pickle
	`__reduce_ex__(...)` helper for pickle
	`__setattr__(...)` x.__setattr__('name', value) <==> x.name = value
	`__str__(x)` Return str(x)...
Inherited from GTriggerExtension
	`associateTrigger(self, key, function)` Associate a trigger with this object.
	`processTrigger(self, key, ignoreAbort)` Fire the requested trigger if a trigger of that type has been associated with this object.

Property Summary
Inherited from GFObj
	`has_label`

Instance Variable Summary
Inherited from GTriggerCore
	`_triggerFunctions`: Dictionary defining the functions this object should present in action/trigger code.
	`_triggerGet`: Can be set to a method that returns the string value of the object.
	`_triggerGlobal`: If set to True, this object is added to the global namespace.
	`_triggerProperties`: Dictionary defining the properties this object should present in action/trigger code.
	`_triggerSet`: Can be set to a method that sets the value of this object.

Class Variable Summary
`NoneType`	`caption` = None
`NoneType`	`name` = None
`str`	`style` = `'normal'`
`bool`	`transparent` = `False`
Inherited from GTriggerExtension
`dict`	`_validTriggers`: Dictionary with valid trigger names as keys.

Method Details

init(self, parent=None)
(Constructor)

Overrides:: gnue.forms.GFObjects.GFObj.GFObj.__init__

_phase_1_init_(self)

On phase 1 initialization a logical page registers itself at the logic object.

Overrides:: gnue.forms.GFObjects.GFObj.GFObj._phase_1_init_

focus_in(self)

Notify the entry that it has received the focus.

focus_out(self)

Notify the entry that it is going to lose the focus.

The focus change is already decided at this moment, there is no way to stop the focus from changing now.

rearrange_boxes(self)

Calculate the bounding boxes of all GFBox items per page and reparent all children which fit into such a GFBox. As a result all reparented children will have their coordinates reset relative to their owning box (starting with 0/0 as the top-left position).

validate(self)

Validate the entry to decide whether the focus can be moved away from it.

This function can raise an exception, in which case the focus change will be prevented.

Calling this function will implicitly update the value in the associated GFField object.

Class Variable Details

caption

Type:

NoneType

Value:

None

name

Type:

NoneType

Value:

None

style

Type:

str

Value:

'normal'

transparent

Type:

bool

Value:

False

Type GFPage

init(self, parent=None)
(Constructor)

_phase_1_init_(self)

focus_in(self)

focus_out(self)

rearrange_boxes(self)

validate(self)

caption

name

style

transparent

GNUe Home

Private API

Developer's Corner

Type GFPage

__init__(self, parent=None) (Constructor)

_phase_1_init_(self)

focus_in(self)

focus_out(self)

rearrange_boxes(self)

validate(self)

caption

name

style

transparent

GNUe Home

Private API

Developer's Corner

init(self, parent=None)
(Constructor)