Zope 3 apidoc

Interface
zope.app.tree.browser.IStaticTreeSkin

Skin based on Rotterdam that includes the static tree navigation macro.

Base interfaces

Attributes/Fields

locale (Attribute)

Return the locale object associated with this request.
principal (Attribute)

The authenticated principal
publication (Attribute)

The request's publication object

The publication object, an IRequestPublication provides application-specific functionality hooks.
environment (Attribute)

Request environment data

This is a read-only mapping from variable name to value.
bodyStream (Attribute)

The stream that provides the data of the request.

The data returned by the stream will not include any possible header information, which should have been stripped by the server (or previous layer) before.

Also, the body stream might already be read and not return any data. This is commonly done when retrieving the data for the body attribute.

If you access this stream directly to retrieve data, it will not be possible by other parts of the framework to access the data of the request via the body attribute.
method (Attribute)

Request method, normalized to upper case
response (Attribute)

The request's response object

Return an IPublisherResponse for the request.
interaction (Attribute)

The interaction
annotations (Attribute)
Stores arbitrary application data under package-unique keys.

By "package-unique keys", we mean keys that are are unique by virtue of including the dotted name of a package as a prefex. A package name is used to limit the authority for picking names for a package to the people using that package.

For example, when implementing annotations for hypothetical request-persistent adapters in a hypothetical zope.persistentadapter package, the key would be (or at least begin with) the following:
```
"zope.persistentadapter"
```
debug (Attribute)

Debug flags (see IDebugFlags).

* = required

Methods

setPublication(publication)

Set the request's publication object
traverse(object)
Traverse from the given object to the published object

The published object is returned.

The following hook methods on the publication will be called:
- callTraversalHooks is called before each step and after the last step.
- traverseName to actually do a single traversal
retry()

Return a retry request

Return a request suitable for repeating the publication attempt.
__getitem__(key)

Return request data

The only request data are environment variables.
__contains__(key)

Tell if a key exists in the mapping.
keys()

Return the keys of the mapping object.
items()

Return the items of the mapping object.
get(key, default=None)

Get a value for a key

The default is returned if there is no value for the key.
processInputs()

Do any input processing that needs to be done before traversing

This is done after construction to allow the publisher to handle errors that arise.
setPathSuffix(steps)

Add additional traversal steps to be taken after all other traversal

This is used to handle HTTP request methods (except for GET and POST in the case of browser requests) and XML-RPC methods.
__iter__()

Return an iterator for the keys of the mapping object.
getTraversalStack()

Return the request traversal stack

This is a sequence of steps to traverse in reverse order. They will be traversed from last to first.
values()

Return the values of the mapping object.
setupLocale()

Setup the locale object based on languages returned by IUserPreferredLanguages adapter.
setTraversalStack(stack)

Change the traversal stack.

See getTraversalStack.
getPositionalArguments()

Return the positional arguments given to the request.
close()

Release resources held by the request.
setPrincipal(principal)

Set the principal attribute.

It should be IPrincipal wrapped in its AuthenticationService's context.
hold(held)

Hold a reference to an object until the request is closed.

The object should be an IHeld. If it is an IHeld, its release method will be called when it is released.
__len__()

Return the number of items.
supportsRetry()

Check whether the request supports retry

Return a boolean value indicating whether the request can be retried.

Adapters for objects providing this interface:

Specific Adapters

There are no specific adapters registered for this interface.

Extended Adapters

zope.app.apidoc.codemodule.browser.introspector.mappingItemsNamespace (name: items)

registered: Zope3/zope.app.apidoc-3.4.3-py2.4.egg/zope/app/apidoc/codemodule/browser/introspector.zcml (line 35)

requires: zope.interface.common.mapping.IItemMapping , zope.interface.Interface

provides: zope.traversing.interfaces.ITraversable
zope.app.apidoc.codemodule.browser.introspector.mappingItemsNamespace (name: items)

registered: Zope3/zope.app.apidoc-3.4.3-py2.4.egg/zope/app/apidoc/codemodule/browser/introspector.zcml (line 35)

requires: zope.interface.common.mapping.IItemMapping , zope.interface.Interface

provides: zope.traversing.interfaces.ITraversable
zope.app.apidoc.codemodule.browser.introspector.mappingItemsNamespace (name: items)

registered: Zope3/zope.app.apidoc-3.4.3-py2.4.egg/zope/app/apidoc/codemodule/browser/introspector.zcml (line 42)

requires: zope.interface.common.mapping.IItemMapping

provides: zope.traversing.interfaces.ITraversable

Generic Adapters

Views

Interface
zope.app.tree.browser.IStaticTreeSkin

Type: IBrowserSkinType

Base interfaces

Attributes/Fields

Methods

Adapters

Adapters for objects providing this interface:

Specific Adapters

Extended Adapters

Generic Adapters

Views

Browser

Specific views

Extended views

Generic views

XML-RPC

Specific views

Extended views

Generic views

HTTP

Specific views

Extended views

Generic views

FTP

Specific views

Extended views

Generic views

Other

Specific views

Extended views

Generic views

Interface zope.app.tree.browser.IStaticTreeSkin

Type: IBrowserSkinType

Base interfaces

Attributes/Fields

Methods

Adapters

Adapters for objects providing this interface:

Specific Adapters

Extended Adapters

Generic Adapters

Views

Browser

Specific views

Extended views

Generic views

XML-RPC

Specific views

Extended views

Generic views

HTTP

Specific views

Extended views

Generic views

FTP

Specific views

Extended views

Generic views

Other

Specific views

Extended views

Generic views

Interface
zope.app.tree.browser.IStaticTreeSkin