In package com.eden.orchid.api.theme.pages

@Archetype(
    value=ConfigArchetype,
    key="allPages")
public class OrchidPage extends Object implements OptionsHolder, AssetHolder

since: v1.0.0 public

Fields

OrchidContext context final
Field Annotations:
@Getter

OrchidGenerator generator
Field Annotations:
@Getter,
@Setter

OrchidResource resource
Field Annotations:
@Getter,
@Setter

OrchidReference reference
Field Annotations:
@Getter,
@Setter

String key
Field Annotations:
@Getter,
@Setter

OrchidPage next
Field Annotations:
@Getter,
@Setter

OrchidPage previous
Field Annotations:
@Getter,
@Setter

OrchidPage parent
Field Annotations:
@Getter,
@Setter

Map data
Field Annotations:
@Getter,
@Setter

String title
Field Annotations:
@Getter,
@Setter,
@Option,
@Description(
    value="Specify a custom title for this Page, which takes precedence over the title given by its generator.")

String description
Field Annotations:
@Getter,
@Setter,
@Option,
@Description(
    value="Specify a custom description for this page, to include in the meta description tag.")

String layout
Field Annotations:
@Getter,
@Setter,
@Option,
@Description(
    value="The layout to embed this page in, or \'none\' to render the page content without a layout. A page\'s default layout, if none is specified, is `index`")

String[] template
Field Annotations:
@Setter,
@Option,
@Description(
    value="Specify a template or a list of templates to use when rendering this page. The first template that exists will be chosen for this page, otherwise the page\'s default set of templates will be searched for (which typically is customized by the generator that produces this page).")

boolean isCurrent
Field Annotations:
@Getter,
@Setter

boolean isIndexed
Field Annotations:
@Getter,
@Setter

boolean noIndex
Field Annotations:
@Getter,
@Setter,
@Option,
@Description(
    value="Request that search engines do not index this page by adding a meta tag on in the page\'s head.")

boolean noFollow
Field Annotations:
@Getter,
@Setter,
@Option,
@Description(
    value="Request that search engines do not follow links from this page by adding a meta tag on in the page\'s head.")

String changeFrequency
Field Annotations:
@Getter,
@Setter,
@Option,
@Description(
    value="A rough estimate of how frequently the content of this page changes, primarily to include in the generated sitemap.xml. One of [always, hourly, daily, weekly, monthly, yearly, never].")

float relativePriority
Field Annotations:
@Getter,
@Setter,
@Option,
@Description(
    value="The importance of this page relative to the rest of the pages on your site. Should be a value between 0 and 1.")

boolean draft
Field Annotations:
@Setter,
@Option,
@BooleanDefault(
    value=false),
@Description(
    value="Set this page as currently being a draft. Drafts will not be included in the rendered site.")

AssetHolder assets
Field Annotations:
@Getter,
@Setter

BreadcrumbHolder breadcrumbs
Field Annotations:
@Setter

OrchidMenu menu
Field Annotations:
@Getter,
@Setter,
@Option,
@Description(
    value="The secondary only added to this page. It is common for generators to add menu items to their pagesautomcatically, but the menu specified on the page will take precedence over the generator\'s page.")

ComponentHolder components
Field Annotations:
@Getter,
@Setter,
@Option,
@Description(
    value="The components that comprise the main content body for this page. The \'intrinsic content\' of the page, which is typically the rendered markup of the containing file, is added by default as a component of type `pageContent` if none are specified. The full `pageContent` component is rendered within the chosen page template. If a custom list of components is given, you will need to add the `pageContent` component yourself.")

String[] extraCss
Field Annotations:
@Getter,
@Setter,
@Option,
@Description(
    value="Add extra CSS files to this page only, which will be compiled just like the rest of the site\'s assets.")

String[] extraJs
Field Annotations:
@Getter,
@Setter,
@Option,
@Description(
    value="Add extra Javascript files to every this page only, which will be compiled just like the rest of the site\'s assets.")

String defaultBreadcrumbs
Field Annotations:
@Getter,
@Setter,
@Option,
@Description(
    value="The default breadcrumbs to display for this page.")

Constructors

OrchidPage(OrchidResource resource, String key) public

Parameters:
OrchidPage(OrchidResource resource, String key, String title) public

Parameters:
OrchidPage(OrchidResource resource, String key, String title, String path) public

Parameters:

Methods

void initialize(String title) protected

Parameters:
  • String title
void postInitialize(String title) protected

Parameters:
  • String title

void isDraft() final public

String getContent() public

Theme getTheme() public

void shouldRender() public

List<E> getTemplates() public

JSONObject toJSON() public

JSONObject toJSON(boolean includePageContent, boolean includePageData) public

Parameters:
  • includePageContent
  • includePageData
Map<K, V> serializeData() protected

OrchidPage fromJSON(OrchidContext context, JSONObject source) static public

Parameters:
String toString() public
Method Annotations:
@Override

AssetHolder getAssetHolder() final public
Method Annotations:
@Override

List<E> getScripts() final public
Method Annotations:
@Override

List<E> getStyles() final public
Method Annotations:
@Override

void addAssets() final public

BreadcrumbHolder getBreadcrumbHolder() final public

List<E> getBreadCrumbs() final public

List<E> getBreadCrumbs(String key) final public

Parameters:
  • String key
ComponentHolder getComponentHolders() protected

void addComponents() public

void loadAssets() public

void free() public

Map<K, V> getMap() public

void has(String key) public

Parameters:
  • String key
Object get(String key) public

Parameters:
  • String key
Object query(String key) public

Parameters:
  • String key