zms.ZMSCharformatManager.ZMSCharformatManager

class documentation

class ZMSCharformatManager(object): (source)

Manages character formats (charformats) for ZMS rich-text editing, including XML import/export, CRUD operations, and reordering.

Method	`delCharformat`	Delete a character format by id.
Method	`getCharFormats`	Return the configured character format definitions.
Method	`importCharformatXml`	Import one or more character formats from XML data.
Method	`manage_changeCharformat`	Handle ZMI actions for creating, editing, and deleting char formats.
Method	`moveCharformat`	Move a character format to another list position.
Method	`setCharformat`	Create or update a character format definition.
Instance Variable	`charformats`	Undocumented
Method	`_importCharformatXml`	Import a single character format definition from parsed XML data.

def delCharformat(self, id): (source) ¶

Delete a character format by id.

Parameters
id:`str`	Character format identifier.
Returns
`str`	Empty string for legacy callers.

Return the configured character format definitions.

Returns
`list`	Character format definitions.

def importCharformatXml(self, xml): (source) ¶

Import one or more character formats from XML data.

Parameters
xml:`str`	XML string or uploaded file-like object.

def manage_changeCharformat(self, lang, btn, REQUEST, RESPONSE): (source) ¶

Handle ZMI actions for creating, editing, and deleting char formats.

Parameters
lang:`str`	Active UI language.
btn:`str`	Submitted button id.
REQUEST:`ZPublisher.HTTPRequest`	The active HTTP request.
RESPONSE:`ZPublisher.HTTPResponse`	The active HTTP response.
Returns
`object`	Redirect response or XML export payload.

def moveCharformat(self, id, pos): (source) ¶

Move a character format to another list position.

Parameters
id:`str`	Character format identifier.
pos:`int`	Target list position.

def setCharformat(self, oldId, newId, newIconClazz, newDisplay, newTag='', newAttrs='', newJS=''): (source) ¶

Create or update a character format definition.

Parameters
oldId:`str`	Existing character format id to replace.
newId:`str`	Target character format id.
newIconClazz:`str`	Icon CSS class.
newDisplay:`str`	Display label.
newTag:`str`	HTML tag wrapper.
newAttrs:`str`	HTML attributes.
newJS:`str`	Client-side JavaScript hook.
Returns
`str`	The persisted character format id.

Undocumented

def _importCharformatXml(self, item): (source) ¶

Import a single character format definition from parsed XML data.

Parameters
item:`dict`	Parsed character format description.