XmlDoc
API
Generated with
XmlDoc/com.phasmidsoftware.xmldoc/com.phasmidsoftware.xmldoc.idml/Story

Story

com.phasmidsoftware.xmldoc.idml.Story
See theStory companion class
object Story

Attributes

Companion
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Story.type

Members list

Type members

Inherited and Abstract types

type MirroredElemLabels <: Tuple

The names of the product elements.

The names of the product elements.

Attributes

Inherited from:
Mirror
type MirroredLabel <: String

The name of the type.

The name of the type.

Attributes

Inherited from:
Mirror

Value members

Concrete methods

def fromGenericElement(e: GenericElement): Try[Story]

Method to extract a Story from a GenericElement, provided it is tagged "Story" and has a Self attribute.

Method to extract a Story from a GenericElement, provided it is tagged "Story" and has a Self attribute.

Value parameters

e

the element to convert.

Attributes

Returns

a Try of Story.

def toGenericElement(story: Story): GenericElement

Method to convert a Story back into a GenericElement, e.g. for rendering.

Method to convert a Story back into a GenericElement, e.g. for rendering.

Value parameters

story

the Story to convert.

Attributes

Returns

a GenericElement tagged "Story", with Self restored as its first attribute (matching where InDesign itself always places it).

Generated with