Options
All
  • Public
  • Public/Protected
  • All
Menu

Class EntityBuffer

An EntityRec that manages two copies internally, a before and after, for 'undo' and comparison purposes. An EntityRec Represents a 'Record' or set of Prop (names and values). An EntityRec may also have DataAnnos (style annotations) that apply to the whole 'record'

Hierarchy

  • EntityBuffer

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Private Optional _after

_after: EntityRec

Private _before

_before: EntityRec

Accessors

after

  • Returns EntityRec

annos

  • Returns Array<DataAnno>

backgroundColor

  • get backgroundColor(): string

  • Returns string

before

  • Returns EntityRec

foregroundColor

  • get foregroundColor(): string

  • Returns string

imageName

  • get imageName(): string

  • Returns string

imagePlacement

  • get imagePlacement(): string

  • Returns string

isBoldText

  • get isBoldText(): boolean

  • Returns boolean

isItalicText

  • get isItalicText(): boolean

  • Returns boolean

isPlacementCenter

  • get isPlacementCenter(): boolean

  • Returns boolean

isPlacementLeft

  • get isPlacementLeft(): boolean

  • Returns boolean

isPlacementRight

  • get isPlacementRight(): boolean

  • Returns boolean

isPlacementStretchUnder

  • get isPlacementStretchUnder(): boolean

  • Returns boolean

isPlacementUnder

  • get isPlacementUnder(): boolean

  • Returns boolean

isUnderline

  • get isUnderline(): boolean

  • Returns boolean

objectId

  • get objectId(): string

  • Returns string

overrideText

  • get overrideText(): string

  • Returns string

propCount

  • get propCount(): number

  • Returns number

propNames

  • get propNames(): Array<string>

  • Returns Array<string>

propValues

  • get propValues(): Array<any>

  • Returns Array<any>

props

  • get props(): Array<Prop>

  • Returns Array<Prop>

tipText

  • get tipText(): string

  • Returns string

Methods

afterEffects

annosAtName

  • annosAtName(propName: string): Array<DataAnno>

backgroundColorFor

  • backgroundColorFor(propName: string): string

foregroundColorFor

  • foregroundColorFor(propName: string): string

imageNameFor

  • imageNameFor(propName: string): string

  • Parameters

    • propName: string

    Returns string

imagePlacementFor

  • imagePlacementFor(propName: string): string

isBoldTextFor

  • isBoldTextFor(propName: string): boolean

  • Parameters

    • propName: string

    Returns boolean

isChanged

  • isChanged(name: string): boolean

  • Parameters

    • name: string

    Returns boolean

isItalicTextFor

  • isItalicTextFor(propName: string): boolean

  • Parameters

    • propName: string

    Returns boolean

isPlacementCenterFor

  • isPlacementCenterFor(propName: string): boolean

isPlacementLeftFor

  • isPlacementLeftFor(propName: string): boolean

isPlacementRightFor

  • isPlacementRightFor(propName: string): boolean

isPlacementStretchUnderFor

  • isPlacementStretchUnderFor(propName: string): boolean

isPlacementUnderFor

  • isPlacementUnderFor(propName: string): boolean

isUnderlineFor

  • isUnderlineFor(propName: string): boolean

  • Parameters

    • propName: string

    Returns boolean

overrideTextFor

  • overrideTextFor(propName: string): string

  • Parameters

    • propName: string

    Returns string

propAtIndex

  • propAtIndex(index: number): Prop

propAtName

  • propAtName(propName: string): Prop

  • Parameters

    • propName: string

    Returns Prop

setValue

  • setValue(name: string, value: any): void

  • Parameters

    • name: string
    • value: any

    Returns void

tipTextFor

  • tipTextFor(propName: string): string

  • Parameters

    • propName: string

    Returns string

toEntityRec

toWS

toWSEditorRecord

valueAtName

  • valueAtName(propName: string): any

  • Parameters

    • propName: string

    Returns any

Static createEntityBuffer

  • Parameters

    • objectId: string
    • before: Array<Prop>
    • after: Array<Prop>

    Returns EntityBuffer

Generated using TypeDoc