Package com.adobe.cq.wcm.core.components.models

Interface HtmlPageItem

public interface HtmlPageItem

This interface defines items that can be included on a page.

Since:

com.adobe.cq.wcm.core.components.models 12.16.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	HtmlPageItem.Element	enum that defines the possible HTML elements for a page item
static class	HtmlPageItem.Location	enum that defines possible insert positions for a page item.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	NN_ATTRIBUTES	Deprecated. since 12.18.0
static java.lang.String	PN_ELEMENT	Deprecated. since 12.18.0
static java.lang.String	PN_HREF	HREF attribute for HtmlPageItem.Element.LINK page items
static java.lang.String	PN_LOCATION	Deprecated. since 12.18.0
static java.lang.String	PN_SRC	SRC attribute for HtmlPageItem.Element.SCRIPT page items

Method Summary

Modifier and Type	Method	Description
default java.util.Map<java.lang.String,java.lang.Object>	getAttributes()	Returns the HTML attributes and values for the page item element.
default HtmlPageItem.Element	getElement()	Returns the HtmlPageItem.Element type for the page item.
default HtmlPageItem.Location	getLocation()	Returns the HtmlPageItem.Location where the page item should be inserted.

Field Detail

PN_ELEMENT

@Deprecated
static final java.lang.String PN_ELEMENT

Deprecated.

since 12.18.0

Property name that defines the type of the HTML element rendered by the page item

Since:

com.adobe.cq.wcm.core.components.models 12.16.0

See Also:

Constant Field Values

PN_LOCATION

@Deprecated
static final java.lang.String PN_LOCATION

Deprecated.

since 12.18.0

Property that defines the location (header or footer) where the page item should be inserted

Since:

com.adobe.cq.wcm.core.components.models 12.16.0

See Also:

Constant Field Values

NN_ATTRIBUTES

@Deprecated
static final java.lang.String NN_ATTRIBUTES

Deprecated.

since 12.18.0

Sub-node that holds the page item's attributes

Since:

com.adobe.cq.wcm.core.components.models 12.16.0

See Also:

Constant Field Values

PN_HREF

static final java.lang.String PN_HREF

HREF attribute for HtmlPageItem.Element.LINK page items

Since:

com.adobe.cq.wcm.core.components.models 12.16.0

See Also:

Constant Field Values

PN_SRC

static final java.lang.String PN_SRC

SRC attribute for HtmlPageItem.Element.SCRIPT page items

Since:

com.adobe.cq.wcm.core.components.models 12.16.0

See Also:

Constant Field Values

Method Detail

getElement

default HtmlPageItem.Element getElement()

Returns the HtmlPageItem.Element type for the page item.

Returns:

HtmlPageItem.Element type

Since:

com.adobe.cq.wcm.core.components.models 12.16.0

getLocation

default HtmlPageItem.Location getLocation()

Returns the HtmlPageItem.Location where the page item should be inserted.

Returns:

HtmlPageItem.Location where item should be inserted

Since:

com.adobe.cq.wcm.core.components.models 12.16.0

getAttributes

default java.util.Map<java.lang.String,java.lang.Object> getAttributes()

Returns the HTML attributes and values for the page item element.

Returns:

HTML attributes and values

Since:

com.adobe.cq.wcm.core.components.models 12.16.0