Back to index

plone3  3.1.7
Public Member Functions
CMFPlone.interfaces.OrderedContainer.IOrderedContainer Class Reference
Inheritance diagram for CMFPlone.interfaces.OrderedContainer.IOrderedContainer:
Inheritance graph
[legend]
Collaboration diagram for CMFPlone.interfaces.OrderedContainer.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
def moveObjectToPosition

Detailed Description

Ordered Container interface.

This interface provides a common mechanism for maintaining ordered
collections.

Definition at line 9 of file OrderedContainer.py.


Member Function Documentation

Get the position of an object by its id.

Permission -- Access contents information

Returns -- Position

Definition at line 88 of file OrderedContainer.py.

00088 
00089     def getObjectPosition(id):
00090         """ Get the position of an object by its id.
00091 
00092         Permission -- Access contents information
00093 
00094         Returns -- Position
00095         """

Here is the caller graph for this function:

def CMFPlone.interfaces.OrderedContainer.IOrderedContainer.moveObjectsByDelta (   ids,
  delta,
  subset_ids = None 
)
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 16 of file OrderedContainer.py.

00016 
00017     def moveObjectsByDelta(ids, delta, subset_ids=None):
00018         """ Move specified sub-objects by delta.
00019 
00020         If delta is higher than the possible maximum, objects will be moved to
00021         the bottom. If delta is lower than the possible minimum, objects will
00022         be moved to the top.
00023 
00024         If subset_ids is not None, delta will be interpreted relative to the
00025         subset specified by a sequence of ids. The position of objects that
00026         are not part of this subset will not be changed.
00027 
00028         The order of the objects specified by ids will always be preserved. So
00029         if you don't want to change their original order, make sure the order
00030         of ids corresponds to their original order.
00031 
00032         If an object with id doesn't exist an error will be raised.
00033 
00034         Permission -- Manage properties
00035 
00036         Returns -- Number of moved sub-objects
00037         """

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 49 of file OrderedContainer.py.

00049 
00050     def moveObjectsDown(ids, delta=1):
00051         """ Move specified sub-objects down by delta in container.
00052 
00053         If no delta is specified, delta is 1. See moveObjectsByDelta for more
00054         details.
00055 
00056         Permission -- Manage properties
00057 
00058         Returns -- Number of moved sub-objects
00059         """

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 70 of file OrderedContainer.py.

00070 
00071     def moveObjectsToBottom(ids):
00072         """ Move specified sub-objects to bottom of container.
00073 
00074         See moveObjectsByDelta for more details.
00075 
00076         Permission -- Manage properties
00077 
00078         Returns -- Number of moved sub-objects
00079         """

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 60 of file OrderedContainer.py.

00060 
00061     def moveObjectsToTop(ids):
00062         """ Move specified sub-objects to top of container.
00063 
00064         See moveObjectsByDelta for more details.
00065 
00066         Permission -- Manage properties
00067 
00068         Returns -- Number of moved sub-objects
00069         """

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 38 of file OrderedContainer.py.

00038 
00039     def moveObjectsUp(ids, delta=1):
00040         """ Move specified sub-objects up by delta in container.
00041 
00042         If no delta is specified, delta is 1. See moveObjectsByDelta for more
00043         details.
00044 
00045         Permission -- Manage properties
00046 
00047         Returns -- Number of moved sub-objects
00048         """

Moves specified object to absolute position.

Permission -- Manage properties

Returns -- Number of moved sub-objects

Definition at line 96 of file OrderedContainer.py.

00096 
00097     def moveObjectToPosition(id, position):
00098         """ Moves specified object to absolute position.
00099 
00100         Permission -- Manage properties
00101 
00102         Returns -- Number of moved sub-objects
00103         """

Here is the caller graph for this function:

Order sub-objects by key and direction.

Permission -- Manage properties

Returns -- Number of moved sub-objects

Definition at line 80 of file OrderedContainer.py.

00080 
00081     def orderObjects(key, reverse=None):
00082         """ Order sub-objects by key and direction.
00083 
00084         Permission -- Manage properties
00085 
00086         Returns -- Number of moved sub-objects
00087         """

Here is the caller graph for this function:


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