n2n Page Rocket 1 API

­Ei­Mask

Methods summary

Methods in detail

• __construct

  public __construct ( EiType eiType )

• extends

  public extends ( EiTypeExtension eiTypeExtension )

• isExtension

  boolean public isExtension ( )

  return

  boolean

• getExtension

  EiTypeExtension public getExtension ( )

  return

  EiTypeExtension

  throws

  IllegalStateException if EiMask returns false.

• getEiType

  public getEiType ( )

• getDef

  EiMaskDef public getDef ( )

  return

  EiMaskDef

• getModuleNamespace

  public getModuleNamespace ( )

• getLabelLstr

  Lstr public getLabelLstr ( )

  return

  Lstr

• getPluralLabelLstr

  Lstr public getPluralLabelLstr ( )

  return

  Lstr

• getIconType

  string public getIconType ( )

  return

  string

• getEiPropCollection

  EiPropCollection public getEiPropCollection ( )

  return

  EiPropCollection

• getEiCommandCollection

  EiCommandCollection public getEiCommandCollection ( )

  return

  EiCommandCollection

• getEiModificatorCollection

  EiModificatorCollection public getEiModificatorCollection ( )

  return

  EiModificatorCollection

• hasEiEngine

  boolean public hasEiEngine ( )

  return

  boolean

• getEiEngine

  EiEngine public getEiEngine ( )

  return

  EiEngine

• setupEiEngine

  Closure public setupEiEngine ( )

  throws

  IllegalStateException

  return

  Closure

• onEiEngineSetup

  public onEiEngineSetup ( Closure callback )

  param

  Closure callback

• offEiEngineSetup

  public offEiEngineSetup ( Closure callback )

  param

  Closure callback

• setDisplayScheme

  public setDisplayScheme ( DisplayScheme displayScheme )

  param

  DisplayScheme

• getDisplayScheme

  DisplayScheme public getDisplayScheme ( )

  return

  DisplayScheme

• isDraftingEnabled

  boolean public isDraftingEnabled ( )

  return

  boolean

• createIdentityString

  string public createIdentityString ( EiObject eiObject , N2nLocale n2nLocale )

  param

  EiObject

  N2nLocale

  return

  string

• sortOverallControls

  public sortOverallControls ( array controls , EiGui eiGui , HtmlView view )

  see

  EiMask::sortOverallControls()

• sortEntryControls

  public sortEntryControls ( array controls , EiEntryGui eiEntryGui , HtmlView view )

• createEiGuiViewFactory

  public createEiGuiViewFactory ( EiGui eiGui )

• getSupremeEiMask

  public getSupremeEiMask ( )

• getSubEiMaskByEiTypeId

  public getSubEiMaskByEiTypeId ( unknown eiTypeId )

• isPreviewSupported

  public isPreviewSupported ( )

• lookupPreviewController

  public lookupPreviewController ( EiFrame eiFrame , PreviewModel previewModel = null )

• __toString

  public __toString ( )

• setupEiFrame

  public setupEiFrame ( EiFrame eiFrame )

  todo

  todo: move to EiEngine!!

  param

  EiFrame