@ConsumerType public interface Page extends ContainerExporter
Page
Sling Model used for the /apps/core/wcm/components/page
component.Modifier and Type | Field and Description |
---|---|
static String |
FN_FAVICON_ICO
Expected file name for the regular favicon file.
|
static String |
FN_FAVICON_PNG
Expected file name for the PNG-format favicon file.
|
static String |
FN_TOUCH_ICON_120
Expected file name for the touch 120px square favicon file.
|
static String |
FN_TOUCH_ICON_152
Expected file name for the touch 152px square favicon file.
|
static String |
FN_TOUCH_ICON_60
Expected file name for the touch 60px square favicon file.
|
static String |
FN_TOUCH_ICON_76
Expected file name for the touch 76px square favicon file.
|
static String |
PN_APP_RESOURCES_CLIENTLIB
Name of the configuration policy property that will store the category of the client library from which web application resources
will be served.
|
static String |
PN_FAVICON_ICO
Key used for the regular favicon file.
|
static String |
PN_FAVICON_PNG
Key for the PNG-format favicon file.
|
static String |
PN_TOUCH_ICON_120
Key for the touch-enabled 120px square favicon file.
|
static String |
PN_TOUCH_ICON_152
Key for the touch-enabled 152px square favicon file.
|
static String |
PN_TOUCH_ICON_60
Key for the touch-enabled 60px square favicon file.
|
static String |
PN_TOUCH_ICON_76
Key for the touch-enabled 76px square favicon file.
|
Modifier and Type | Method and Description |
---|---|
default @Nullable String |
getAppResourcesPath()
Returns the root path of the application's web resources (e.g.
|
default String[] |
getClientLibCategories()
If this page is associated with a Template, then this method will return the Template's client library categories
to be included in the page as defined by the user in the policy.
|
default String[] |
getClientLibCategoriesJsBody()
If this page is associated with a Template, then this method will return the JavaScript client library categories
which are intended specifically to be loaded at the page body end (JavaScript only), as defined by the user in the policy.
|
default String[] |
getClientLibCategoriesJsHead()
If this page is associated with a Template, then this method will return the JavaScript client library categories
which are intended specifically to be loaded up front in the page head (JavaScript only), as defined by the user in the policy.
|
default String |
getCssClassNames()
Returns the CSS classes defined for the page
|
default String |
getDesignPath()
Retrieves the page's design path.
|
default @NotNull Map<String,? extends ComponentExporter> |
getExportedItems()
Returns the map of all exported child items (resource names from Sling Model classes).
|
default @NotNull String[] |
getExportedItemsOrder()
Returns the order of items in the map.
|
default @NotNull String |
getExportedType()
Returns the type of the resource for which the export is performed.
|
default Map<String,String> |
getFavicons()
Deprecated.
since 12.2.0
|
default String[] |
getKeywords()
Returns an array with the page's keywords.
|
default String |
getLanguage()
Returns the language of this page, if one has been defined.
|
default Calendar |
getLastModifiedDate()
Returns the last modified date of this page.
|
default @Nullable NavigationItem |
getRedirectTarget()
Returns the target page if this page is redirecting to another page.
|
default String |
getStaticDesignPath()
Retrieves the static design path if
static.css exists in the design path. |
default String |
getTemplateName()
Returns the template name of the currently used template.
|
default String |
getTitle()
Returns the title of this page.
|
default boolean |
hasCloudconfigSupport()
Checks if there's support for cloudconfig script tags so they can be added to page header/footer
|
static final String PN_FAVICON_ICO
getFavicons()
,
Constant Field Valuesstatic final String PN_FAVICON_PNG
getFavicons()
,
Constant Field Valuesstatic final String PN_TOUCH_ICON_60
getFavicons()
,
Constant Field Valuesstatic final String PN_TOUCH_ICON_76
getFavicons()
,
Constant Field Valuesstatic final String PN_TOUCH_ICON_120
getFavicons()
,
Constant Field Valuesstatic final String PN_TOUCH_ICON_152
getFavicons()
,
Constant Field Valuesstatic final String PN_APP_RESOURCES_CLIENTLIB
static final String FN_FAVICON_ICO
getFavicons()
,
Constant Field Valuesstatic final String FN_FAVICON_PNG
getFavicons()
,
Constant Field Valuesstatic final String FN_TOUCH_ICON_60
getFavicons()
,
Constant Field Valuesstatic final String FN_TOUCH_ICON_76
getFavicons()
,
Constant Field Valuesstatic final String FN_TOUCH_ICON_120
getFavicons()
,
Constant Field Valuesstatic final String FN_TOUCH_ICON_152
getFavicons()
,
Constant Field Valuesdefault String getLanguage()
Locale
will be used.default
in 12.1.0default Calendar getLastModifiedDate()
Calendar
representing the last modified date of this pagedefault
in 12.1.0default String[] getKeywords()
String
s; the array can be empty if no keywords have been defined for the pagedefault
in 12.1.0default String getDesignPath()
String
default
in 12.1.0default String getStaticDesignPath()
static.css
exists in the design path.null
otherwisedefault
in 12.1.0@Deprecated default Map<String,String> getFavicons()
Retrieves the paths to the various favicons for the website as <favicon_name>:<path>
pairs.
If a file corresponding to a particular type of favicon is found under the page's design path, then the <favicon_name>:<path> pair is added to the map, otherwise that type of favicon is ignored. The following list defines the currently supported favicons along with their brief descriptions:
PN_FAVICON_ICO
: The favicon.ico faviconPN_FAVICON_PNG
: The png version of the faviconPN_TOUCH_ICON_60
: The touch icon with size 60pxPN_TOUCH_ICON_76
: The touch icon with size 76pxPN_TOUCH_ICON_120
: The touch icon with size 120pxPN_TOUCH_ICON_152
: The touch icon with size 152pxMap
containing the names of the favicons and their corresponding pathsdefault
in 12.1.0default String getTitle()
default
in 12.1.0default String[] getClientLibCategories()
default
in 12.1.0default String[] getClientLibCategoriesJsBody()
default String[] getClientLibCategoriesJsHead()
default String getTemplateName()
default
in 12.1.0@Nullable default @Nullable String getAppResourcesPath()
null
if no such resources were defineddefault String getCssClassNames()
String
containing the CSS classes defined for the page, if one class exists, null
otherwise@Nullable default @Nullable NavigationItem getRedirectTarget()
NavigationItem
of redirect targetdefault boolean hasCloudconfigSupport()
true
if there's support for cloudconfig script tags@NotNull default @NotNull String[] getExportedItemsOrder()
ContainerExporter
Returns the order of items in the map.
NOTE: This information is required because the JSON specification and most implementations don't provide a stable order of items in JSON objects. Methods whose JSON serialization would lead to the same JSON property name (":order") will not be serialized.
getExportedItemsOrder
in interface ContainerExporter
ContainerExporter.getExportedItemsOrder()
@NotNull default @NotNull Map<String,? extends ComponentExporter> getExportedItems()
ContainerExporter
Returns the map of all exported child items (resource names from Sling Model classes).
NOTE: Methods whose JSON serialization would lead to the same JSON property name (":items") will not be serialized.
getExportedItems
in interface ContainerExporter
ContainerExporter.getExportedItems()
@NotNull default @NotNull String getExportedType()
ComponentExporter
Returns the type of the resource for which the export is performed.
NOTE: methods whose JSON serialization would lead to the same JSON property name (":type") will not be serialized.
getExportedType
in interface ComponentExporter
ComponentExporter.getExportedType()
Copyright © 2010 - 2020 Adobe. All Rights Reserved