Back to index

plone3  3.1.7
Public Member Functions
kss.core.plugins.core.interfaces.IKSSCoreCommands Class Reference
Inheritance diagram for kss.core.plugins.core.interfaces.IKSSCoreCommands:
Inheritance graph
[legend]
Collaboration diagram for kss.core.plugins.core.interfaces.IKSSCoreCommands:
Collaboration graph
[legend]

List of all members.

Public Member Functions

def getSelector
def getCssSelector
def getHtmlIdSelector
def getSameNodeSelector
def getParentNodeSelector
def replaceInnerHTML
def replaceHTML
def setAttribute
def setKssAttribute
def setStyle
def insertHTMLAfter
def insertHTMLBefore
def insertHTMLAsFirstChild
def insertHTMLAsLastChild
def clearChildNodes
def deleteNode
def deleteNodeAfter
def deleteNodeBefore
def copyChildNodesFrom
def copyChildNodesTo
def moveNodeAfter
def setStateVar
def continueEvent
def toggleClass
def addClass
def removeClass
def focus

Detailed Description

The core commands

Definition at line 3 of file interfaces.py.


Member Function Documentation

Add a class to a node.

Definition at line 92 of file interfaces.py.

00092 
00093     def addClass(selector, value):
00094         """Add a class to a node."""

Remove all the child nodes from the node specified by selector

Definition at line 54 of file interfaces.py.

00054 
00055     def clearChildNodes(selector):
00056         """Remove all the child nodes from the node specified by selector"""

def kss.core.plugins.core.interfaces.IKSSCoreCommands.continueEvent (   name,
  allnodes = False,
  kw 
)
Trigger an event on the client 

Definition at line 82 of file interfaces.py.

00082 
00083     def continueEvent(name, allnodes=False, **kw):
00084         """Trigger an event on the client """
00085         # TODO: explain a bit better what this does

Copy the child nodes from the node specified by id to the selector node

The copy operation will clear out all childnodes of selector.

Definition at line 66 of file interfaces.py.

00066 
00067     def copyChildNodesFrom(selector, id):
00068         """Copy the child nodes from the node specified by id to the selector node
00069         
00070         The copy operation will clear out all childnodes of selector."""

Copy the child nodes from the selector node to the node specified by id

The copy operation will clear out all childnodes of selector.

Definition at line 71 of file interfaces.py.

00071 
00072     def copyChildNodesTo(selector, id):
00073         """Copy the child nodes from the selector node to the node specified by id
00074         
00075         The copy operation will clear out all childnodes of selector."""

Remove the node itself specified by selector

Definition at line 57 of file interfaces.py.

00057 
00058     def deleteNode(selector):
00059         """Remove the node itself specified by selector"""

Remove the node after the node specified by selector

Definition at line 60 of file interfaces.py.

00060 
00061     def deleteNodeAfter(selector):
00062         """Remove the node after the node specified by selector"""

Remove the node before the node specified by selector

Definition at line 63 of file interfaces.py.

00063 
00064     def deleteNodeBefore(selector):
00065         """Remove the node before the node specified by selector"""

Set focus to selected node.

Definition at line 98 of file interfaces.py.

00098 
00099     def focus(selector):
00100         """Set focus to selected node."""
Return a CSS selector with selector as the value

Definition at line 12 of file interfaces.py.

00012 
00013     def getCssSelector(selector):
00014         """Return a CSS selector with selector as the value"""

Return a HTML id selector with selector as the value

Definition at line 15 of file interfaces.py.

00015 
00016     def getHtmlIdSelector(selector):
00017         """Return a HTML id selector with selector as the value"""

Return a all nodes in the parent chain which match the css
selector

Definition at line 21 of file interfaces.py.

00021 
00022     def getParentNodeSelector(selector):
00023         """Return a all nodes in the parent chain which match the css
00024         selector"""

Return the same node as the value

Definition at line 18 of file interfaces.py.

00018 
00019     def getSameNodeSelector():
00020         """Return the same node as the value"""

Return a specific type of selector

The type can be `css` or `htmlid`. The selector is the value for the
selector.

Definition at line 6 of file interfaces.py.

00006 
00007     def getSelector(type, selector):
00008         """Return a specific type of selector
00009 
00010         The type can be `css` or `htmlid`. The selector is the value for the
00011         selector."""

Here is the caller graph for this function:

def kss.core.plugins.core.interfaces.IKSSCoreCommands.insertHTMLAfter (   selector,
  new_value,
  withKssSetup = 'True' 
)
Insert some HTML after the node indicated by selector

Definition at line 42 of file interfaces.py.

00042 
00043     def insertHTMLAfter(selector, new_value, withKssSetup='True'):
00044         """Insert some HTML after the node indicated by selector"""

def kss.core.plugins.core.interfaces.IKSSCoreCommands.insertHTMLAsFirstChild (   selector,
  new_value,
  withKssSetup = 'True' 
)
Insert some HTML as the first child of the node specified by selector

Definition at line 48 of file interfaces.py.

00048 
00049     def insertHTMLAsFirstChild(selector, new_value, withKssSetup='True'):
00050         """Insert some HTML as the first child of the node specified by selector"""

def kss.core.plugins.core.interfaces.IKSSCoreCommands.insertHTMLAsLastChild (   selector,
  new_value,
  withKssSetup = 'True' 
)
Insert some HTML as the last child of the node specified by selector

Definition at line 51 of file interfaces.py.

00051 
00052     def insertHTMLAsLastChild(selector, new_value, withKssSetup='True'):
00053         """Insert some HTML as the last child of the node specified by selector"""

def kss.core.plugins.core.interfaces.IKSSCoreCommands.insertHTMLBefore (   selector,
  new_value,
  withKssSetup = 'True' 
)
Insert some HTML before the node specified by selector

Definition at line 45 of file interfaces.py.

00045 
00046     def insertHTMLBefore(selector, new_value, withKssSetup='True'):
00047         """Insert some HTML before the node specified by selector"""

Move the node indicated by selector to a sibling after id

Definition at line 76 of file interfaces.py.

00076 
00077     def moveNodeAfter(selector, id):
00078         """Move the node indicated by selector to a sibling after id"""

Remove a class from a node.

Definition at line 95 of file interfaces.py.

00095 
00096     def removeClass(selector, value):
00097         """Remove a class from a node."""

def kss.core.plugins.core.interfaces.IKSSCoreCommands.replaceHTML (   selector,
  new_value,
  withKssSetup = 'True' 
)
Replace the node itself with new_value

Node selection is done using the selector argument.

Definition at line 28 of file interfaces.py.

00028 
00029     def replaceHTML(selector, new_value, withKssSetup='True'):
00030         """Replace the node itself with new_value
00031         
00032         Node selection is done using the selector argument."""

def kss.core.plugins.core.interfaces.IKSSCoreCommands.replaceInnerHTML (   selector,
  new_value,
  withKssSetup = 'True' 
)
Replace the contents of a node (selector) with the new_value

Definition at line 25 of file interfaces.py.

00025 
00026     def replaceInnerHTML(selector, new_value, withKssSetup='True'):
00027         """Replace the contents of a node (selector) with the new_value"""

def kss.core.plugins.core.interfaces.IKSSCoreCommands.setAttribute (   selector,
  name,
  value 
)
Set an attribute on node(s) specified by the selector

Definition at line 33 of file interfaces.py.

00033 
00034     def setAttribute(selector, name, value):
00035         """Set an attribute on node(s) specified by the selector"""

Set a KSS attribute on node(s) specified by the selector

Definition at line 36 of file interfaces.py.

00036 
00037     def setKssAttribute(selector, name, value):
00038         """Set a KSS attribute on node(s) specified by the selector"""

Set a client side kukit variable

Definition at line 79 of file interfaces.py.

00079 
00080     def setStateVar(varname, value):
00081         """Set a client side kukit variable"""

def kss.core.plugins.core.interfaces.IKSSCoreCommands.setStyle (   selector,
  name,
  value 
)
Set the style attribute of nodes specified by the selector

Definition at line 39 of file interfaces.py.

00039 
00040     def setStyle(selector, name, value):
00041         """Set the style attribute of nodes specified by the selector"""

Add/remove a class to/from a node.

If the class is present it will be removed. Else the class will be
added.  

Definition at line 86 of file interfaces.py.

00086 
00087     def toggleClass(selector, value):
00088         """Add/remove a class to/from a node.
00089         
00090         If the class is present it will be removed. Else the class will be
00091         added.  """


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