pageTemplate

Parent: theme

Children: slot, templateOption

Direct Properties:

PropertyTypeRequiredDefault ValueDetails
namestringYesdata type=string; maxLen=255
The display name of this template.
templateClassenumNodata type=string; lov=STATIC
Valid values: login noTabs noTabsWithSidebar oneLevelTabs oneLevelTabsWithSidebar popup printerFriendly twoLevelTabs twoLevelTabsWithSidebar custom1 custom2 custom3 custom4 custom5 custom6 custom7 custom8

Property Groups:

  • templateOptions
  • page
  • javaScript
  • css
  • subtemplate
  • layout
  • positions
  • dialog
  • errorPage
  • standardTab
  • parentTab
  • imageBasedTab
  • advanced
  • subscription
  • comments
templateOptions
PropertyTypeRequiredDefault ValueDetails
presetarray of stringsNodata type=string; lov=TEMPLATE_OPTIONS
defaultarray of stringsNodata type=string; lov=TEMPLATE_OPTIONS
templateOptions {
  preset: [
    value
    value
  ]
  default: [
    value
    value
  ]
}
page
PropertyTypeRequiredDefault ValueDetails
typeenumYesnormaldata type=string; lov=STATIC
Valid values: dialog normal
headermultiline stringYesdata type=multiline string; maxLen=32767
bodymultiline stringYesdata type=multiline string; maxLen=32767
footermultiline stringNodata type=multiline string; maxLen=32767
page {
  type: dialog
  header: ```html
    value
  ```
  body: ```html
    value
  ```
  footer: ```html
    value
  ```
}
javaScript
PropertyTypeRequiredDefault ValueDetails
fileUrlsarray of stringsNodata type=string; maxLen=4000
functionAndGlobalVariableDeclarationmultiline stringNodata type=multiline string; maxLen=32767
executeWhenPageLoadsmultiline stringNodata type=multiline string; maxLen=32767
javaScript {
  fileUrls: [
    value
    value
  ]
  functionAndGlobalVariableDeclaration: ```javascript-browser
    value
  ```
  executeWhenPageLoads: ```javascript-browser
    value
  ```
}
css
PropertyTypeRequiredDefault ValueDetails
fileUrlsarray of stringsNodata type=string; maxLen=4000
inlinemultiline stringNodata type=multiline string; maxLen=32767
css {
  fileUrls: [
    value
    value
  ]
  inline: ```css
    value
  ```
}
subtemplate
PropertyTypeRequiredDefault ValueDetails
successMessagemultiline stringNodata type=multiline string; maxLen=4000
navigationBarmultiline stringNodata type=multiline string; maxLen=4000
navigationBarEntrymultiline stringNodata type=multiline string; maxLen=32767
notificationmultiline stringNodata type=multiline string; maxLen=4000
subtemplate {
  successMessage: ```html
    value
  ```
  navigationBar: ```html
    value
  ```
  navigationBarEntry: ```html
    value
  ```
  notification: ```html
    value
  ```
}
layout
PropertyTypeRequiredDefault ValueDetails
typeenumYesfixedNumberOfColumnsdata type=string; lov=STATIC
Valid values: htmlTable fixedNumberOfColumns variableNumberOfColumns
maxColumnsintegerNodata type=integer; maxLen=2
Applies whentype in (fixedNumberOfColumns)type in (variableNumberOfColumns)
alwaysUseMaxColumnsbooleanYesfalsedata type=boolean
Applies whentype = fixedNumberOfColumns
hasColumnSpanbooleanYestruedata type=boolean
Applies whentype in (fixedNumberOfColumns)type in (variableNumberOfColumns)
alwaysRenderLayoutbooleanYestruedata type=boolean
Applies whentype in (fixedNumberOfColumns)type in (variableNumberOfColumns)
emitEmptyLeadingColumnsbooleanYestruedata type=boolean
Applies whentype in (fixedNumberOfColumns)type in (variableNumberOfColumns)
emitEmptyTrailingColumnsbooleanYesfalsedata type=boolean
Applies whentype in (fixedNumberOfColumns)type in (variableNumberOfColumns)
defaultLabelColumnSpanintegerNodata type=integer; maxLen=2
Applies whentype in (fixedNumberOfColumns)type in (variableNumberOfColumns)
firstColumnAttributesstringNodata type=string; maxLen=255
Applies whentype in (fixedNumberOfColumns)type in (variableNumberOfColumns)
lastColumnAttributesstringNodata type=string; maxLen=255
Applies whentype in (fixedNumberOfColumns)type in (variableNumberOfColumns)
regionTableAttributesstringNodata type=string; maxLen=255
Applies whentype = htmlTable
containerTemplatemultiline stringNodata type=multiline string; maxLen=4000
Applies whentype in (fixedNumberOfColumns)type in (variableNumberOfColumns)
rowTemplatemultiline stringNodata type=multiline string; maxLen=4000
Applies whentype in (fixedNumberOfColumns)type in (variableNumberOfColumns)
columnTemplatemultiline stringNodata type=multiline string; maxLen=4000
Applies whentype in (fixedNumberOfColumns)type in (variableNumberOfColumns)
javaScriptDebugCodemultiline stringNodata type=multiline string; maxLen=4000
Applies whentype in (fixedNumberOfColumns)type in (variableNumberOfColumns)
layout {
  type: htmlTable
  maxColumns: 42
  alwaysUseMaxColumns: false
  hasColumnSpan: false
  alwaysRenderLayout: false
  emitEmptyLeadingColumns: false
  emitEmptyTrailingColumns: false
  defaultLabelColumnSpan: 42
  firstColumnAttributes: value
  lastColumnAttributes: value
  regionTableAttributes: value
  containerTemplate: ```html
    value
  ```
  rowTemplate: ```html
    value
  ```
  columnTemplate: ```html
    value
  ```
  javaScriptDebugCode: ```javascript-browser
    value
  ```
}
positions
PropertyTypeRequiredDefault ValueDetails
breadcrumbPositionstringNodata type=string; lov=SLOTS
sidebarPositionstringNodata type=string; lov=SLOTS
positions {
  breadcrumbPosition: value
  sidebarPosition: value
}
dialog
PropertyTypeRequiredDefault ValueDetails
widthstringNodata type=string; maxLen=20
Applies whentype = dialog
heightstringNodata type=string; maxLen=20
Applies whentype = dialog
maxWidthstringNodata type=string; maxLen=20
Applies whentype = dialog
cssClassesarray of stringsNodata type=string; maxLen=255
Applies whentype = dialog
allowEmbedInFramearray of enumsNodata type=string; lov=STATIC
Valid values: modal nonModal
Applies whentype = dialog
initCodestringNodata type=string; maxLen=4000
Applies whentype = dialog
closureCodestringNodata type=string; maxLen=4000
Applies whentype = dialog
cancelCodestringNodata type=string; maxLen=4000
Applies whentype = dialog
dialog {
  width: value
  height: value
  maxWidth: value
  cssClasses: [
    value
    value
  ]
  allowEmbedInFrame: [
    modal
    nonModal
  ]
  initCode: value
  closureCode: value
  cancelCode: value
}
errorPage
PropertyTypeRequiredDefault ValueDetails
templatemultiline stringNodata type=multiline string; maxLen=32767
errorPage {
  template: ```html
    value
  ```
}
standardTab
PropertyTypeRequiredDefault ValueDetails
currentmultiline stringNodata type=multiline string; maxLen=4000
Applies whentype = tabs
currentFontAttributesstringNodata type=string; maxLen=255
Applies whentype = tabs
nonCurrentmultiline stringNodata type=multiline string; maxLen=4000
Applies whentype = tabs
nonCurrentFontAttributesstringNodata type=string; maxLen=255
Applies whentype = tabs
standardTab {
  current: ```html
    value
  ```
  currentFontAttributes: value
  nonCurrent: ```html
    value
  ```
  nonCurrentFontAttributes: value
}
parentTab
PropertyTypeRequiredDefault ValueDetails
currentmultiline stringNodata type=multiline string; maxLen=4000
Applies whentype = tabs
currentFontAttributesstringNodata type=string; maxLen=255
Applies whentype = tabs
nonCurrentmultiline stringNodata type=multiline string; maxLen=4000
Applies whentype = tabs
nonCurrentFontAttributesstringNodata type=string; maxLen=255
Applies whentype = tabs
parentTab {
  current: ```html
    value
  ```
  currentFontAttributes: value
  nonCurrent: ```html
    value
  ```
  nonCurrentFontAttributes: value
}
imageBasedTab
PropertyTypeRequiredDefault ValueDetails
currentmultiline stringNodata type=multiline string; maxLen=4000
nonCurrentmultiline stringNodata type=multiline string; maxLen=4000
imageBasedTab {
  current: ```html
    value
  ```
  nonCurrent: ```html
    value
  ```
}
advanced
PropertyTypeRequiredDefault ValueDetails
staticIdstringYesdata type=string; maxLen=255
identifierstringNodata type=string; maxLen=255
translatablebooleanYesfalsedata type=boolean
advanced {
  staticId: value
  identifier: value
  translatable: false
}
subscription
PropertyTypeRequiredDefault ValueDetails
masterreferenceNodata type=reference; lov=COMPONENT; references=pageTemplate
masterenumNodata type=reference; lov=COMPONENT; references=pageTemplate
Valid values: @/8842.242/universal-theme/drawer @/8842.242/universal-theme/left-and-right-side-columns @/8842.242/universal-theme/left-side-column @/8842.242/universal-theme/login @/8842.242/universal-theme/marquee @/8842.242/universal-theme/minimal-no-navigation @/8842.242/universal-theme/modal-dialog @/8842.242/universal-theme/right-side-column @/8842.242/universal-theme/standard @/8842.242/universal-theme/wizard-modal-dialog @/8842.261/universal-theme/blank @/8842.261/universal-theme/drawer @/8842.261/universal-theme/left-and-right-side-columns @/8842.261/universal-theme/left-side-column @/8842.261/universal-theme/login @/8842.261/universal-theme/marquee @/8842.261/universal-theme/minimal-no-navigation @/8842.261/universal-theme/modal-dialog @/8842.261/universal-theme/right-side-column @/8842.261/universal-theme/standard @/8842.261/universal-theme/wizard-modal-dialog @/8842.262/universal-theme/blank @/8842.262/universal-theme/drawer @/8842.262/universal-theme/left-and-right-side-columns @/8842.262/universal-theme/left-side-column @/8842.262/universal-theme/login @/8842.262/universal-theme/marquee @/8842.262/universal-theme/minimal-no-navigation @/8842.262/universal-theme/modal-dialog @/8842.262/universal-theme/right-side-column @/8842.262/universal-theme/standard @/8842.262/universal-theme/wizard-modal-dialog @/8842.9999/theme-1000/Standard @/8842.9999/theme-1000/dialog @/8842.9999/theme-1000/faceted-search @/8842.9999/theme-1000/login
subscription {
  master: @component
}
comments
PropertyTypeRequiredDefault ValueDetails
commentsmultiline stringNodata type=multiline string; maxLen=4000
comments {
  comments: ```
    value
  ```
}

APEXlang Example

pageTemplate sample (
    name: value
    templateClass: login
    templateOptions {
        preset: [
          value
          value
        ]
        default: [
          value
          value
        ]
    }
    page {
        type: dialog
        header: ```html
          value
        ```
        body: ```html
          value
        ```
        footer: ```html
          value
        ```
    }
    javaScript {
        fileUrls: [
          value
          value
        ]
        functionAndGlobalVariableDeclaration: ```javascript-browser
          value
        ```
        executeWhenPageLoads: ```javascript-browser
          value
        ```
    }
    css {
        fileUrls: [
          value
          value
        ]
        inline: ```css
          value
        ```
    }
    subtemplate {
        successMessage: ```html
          value
        ```
        navigationBar: ```html
          value
        ```
        navigationBarEntry: ```html
          value
        ```
        notification: ```html
          value
        ```
    }
    layout {
        type: htmlTable
        maxColumns: 42
        alwaysUseMaxColumns: false
        hasColumnSpan: false
        alwaysRenderLayout: false
        emitEmptyLeadingColumns: false
        emitEmptyTrailingColumns: false
        defaultLabelColumnSpan: 42
        firstColumnAttributes: value
        lastColumnAttributes: value
        regionTableAttributes: value
        containerTemplate: ```html
          value
        ```
        rowTemplate: ```html
          value
        ```
        columnTemplate: ```html
          value
        ```
        javaScriptDebugCode: ```javascript-browser
          value
        ```
    }
    positions {
        breadcrumbPosition: value
        sidebarPosition: value
    }
    dialog {
        width: value
        height: value
        maxWidth: value
        cssClasses: [
          value
          value
        ]
        allowEmbedInFrame: [
          modal
          nonModal
        ]
        initCode: value
        closureCode: value
        cancelCode: value
    }
    errorPage {
        template: ```html
          value
        ```
    }
    standardTab {
        current: ```html
          value
        ```
        currentFontAttributes: value
        nonCurrent: ```html
          value
        ```
        nonCurrentFontAttributes: value
    }
    parentTab {
        current: ```html
          value
        ```
        currentFontAttributes: value
        nonCurrent: ```html
          value
        ```
        nonCurrentFontAttributes: value
    }
    imageBasedTab {
        current: ```html
          value
        ```
        nonCurrent: ```html
          value
        ```
    }
    advanced {
        staticId: value
        identifier: value
        translatable: false
    }
    subscription {
        master: @component
    }
    comments {
        comments: ```
          value
        ```
    }
)