Back to index

plone3  3.1.7
Public Member Functions
Archetypes.interfaces._orderedfolder.IOrderedContainer Class Reference
Inheritance diagram for Archetypes.interfaces._orderedfolder.IOrderedContainer:
Inheritance graph
[legend]
Collaboration diagram for Archetypes.interfaces._orderedfolder.IOrderedContainer:
Collaboration graph
[legend]

List of all members.

Public Member Functions

def moveObjectsByDelta
def moveObjectsUp
def moveObjectsDown
def moveObjectsToTop
def moveObjectsToBottom
def orderObjects
def getObjectPosition

Detailed Description

Ordered Container interface.

This interface provides a common mechanism for maintaining ordered
collections.

Definition at line 36 of file _orderedfolder.py.


Member Function Documentation

Get the position of an object by its id.

Permission -- Access contents information

Returns -- Position

Definition at line 115 of file _orderedfolder.py.

00115 
00116     def getObjectPosition(id):
00117         """ Get the position of an object by its id.
00118 
00119         Permission -- Access contents information
00120 
00121         Returns -- Position
00122         """

Here is the caller graph for this function:

def Archetypes.interfaces._orderedfolder.IOrderedContainer.moveObjectsByDelta (   ids,
  delta,
  subset_ids = None 
)
Ordered Container interface.

This interface provides a common mechanism for maintaining ordered
collections.
Move specified sub-objects by delta.

If delta is higher than the possible maximum, objects will be moved to
the bottom. If delta is lower than the possible minimum, objects will
be moved to the top.

If subset_ids is not None, delta will be interpreted relative to the
subset specified by a sequence of ids. The position of objects that
are not part of this subset will not be changed.

The order of the objects specified by ids will always be preserved. So
if you don't want to change their original order, make sure the order
of ids corresponds to their original order.

If an object with id doesn't exist an error will be raised.

Permission -- Manage properties

Returns -- Number of moved sub-objects

Definition at line 43 of file _orderedfolder.py.

00043 
00044     def moveObjectsByDelta(ids, delta, subset_ids=None):
00045         """ Move specified sub-objects by delta.
00046 
00047         If delta is higher than the possible maximum, objects will be moved to
00048         the bottom. If delta is lower than the possible minimum, objects will
00049         be moved to the top.
00050 
00051         If subset_ids is not None, delta will be interpreted relative to the
00052         subset specified by a sequence of ids. The position of objects that
00053         are not part of this subset will not be changed.
00054 
00055         The order of the objects specified by ids will always be preserved. So
00056         if you don't want to change their original order, make sure the order
00057         of ids corresponds to their original order.
00058 
00059         If an object with id doesn't exist an error will be raised.
00060 
00061         Permission -- Manage properties
00062 
00063         Returns -- Number of moved sub-objects
00064         """

Here is the caller graph for this function:

Move specified sub-objects down by delta in container.

If no delta is specified, delta is 1. See moveObjectsByDelta for more
details.

Permission -- Manage properties

Returns -- Number of moved sub-objects

Definition at line 76 of file _orderedfolder.py.

00076 
00077     def moveObjectsDown(ids, delta=1):
00078         """ Move specified sub-objects down by delta in container.
00079 
00080         If no delta is specified, delta is 1. See moveObjectsByDelta for more
00081         details.
00082 
00083         Permission -- Manage properties
00084 
00085         Returns -- Number of moved sub-objects
00086         """

Move specified sub-objects to bottom of container.

See moveObjectsByDelta for more details.

Permission -- Manage properties

Returns -- Number of moved sub-objects

Definition at line 97 of file _orderedfolder.py.

00097 
00098     def moveObjectsToBottom(ids):
00099         """ Move specified sub-objects to bottom of container.
00100 
00101         See moveObjectsByDelta for more details.
00102 
00103         Permission -- Manage properties
00104 
00105         Returns -- Number of moved sub-objects
00106         """

Move specified sub-objects to top of container.

See moveObjectsByDelta for more details.

Permission -- Manage properties

Returns -- Number of moved sub-objects

Definition at line 87 of file _orderedfolder.py.

00087 
00088     def moveObjectsToTop(ids):
00089         """ Move specified sub-objects to top of container.
00090 
00091         See moveObjectsByDelta for more details.
00092 
00093         Permission -- Manage properties
00094 
00095         Returns -- Number of moved sub-objects
00096         """

Move specified sub-objects up by delta in container.

If no delta is specified, delta is 1. See moveObjectsByDelta for more
details.

Permission -- Manage properties

Returns -- Number of moved sub-objects

Definition at line 65 of file _orderedfolder.py.

00065 
00066     def moveObjectsUp(ids, delta=1):
00067         """ Move specified sub-objects up by delta in container.
00068 
00069         If no delta is specified, delta is 1. See moveObjectsByDelta for more
00070         details.
00071 
00072         Permission -- Manage properties
00073 
00074         Returns -- Number of moved sub-objects
00075         """

Order sub-objects by key and direction.

Permission -- Manage properties

Returns -- Number of moved sub-objects

Definition at line 107 of file _orderedfolder.py.

00107 
00108     def orderObjects(key, reverse=None):
00109         """ Order sub-objects by key and direction.
00110 
00111         Permission -- Manage properties
00112 
00113         Returns -- Number of moved sub-objects
00114         """

Here is the caller graph for this function:


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