public abstract class AbstractFieldsPresentationElement extends Object
Modifier and Type | Field and Description |
---|---|
protected org.apache.log4j.Logger |
mLogger
a common logger for all implementing classes
|
protected static String |
TO_STRING_FORMAT |
Constructor and Description |
---|
AbstractFieldsPresentationElement(ContentSummary pSummary,
ContentDescriptor pDescriptor,
String pType,
PresentationElement pParent,
int pPublicationId) |
Modifier and Type | Method and Description |
---|---|
PresentationArticle |
getContent()
Returns the content item referenced by a
PresentationElement that represents
a summary. |
Map<String,PresentationProperty<?>> |
getFields()
Returns all the fields in a
PresentationElement that represents a summary. |
String |
getLabel()
Returns the label of the
PresentationElement if the
PresentationElement representas a group or area. |
protected IOHashKey |
getObjectKey() |
PresentationElement |
getParent()
Returns the parent of this element.
|
protected PresentationArticle |
getPresentationArticle() |
PresentationLoader |
getPresentationLoader() |
protected int |
getPublicationId() |
String |
getType()
Returns the type of the
PresentationElement . |
protected void |
handleOptions(Map<String,Object> pOptions,
MapPropertyDescriptor pOptionsPropertyDescriptor,
neo.xredsys.presentation.PresentationFieldTranslator<PropertyDescriptor> pTranslator) |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getAreas, getItems, getKeys, getOptions
protected static final String TO_STRING_FORMAT
protected transient org.apache.log4j.Logger mLogger
public AbstractFieldsPresentationElement(ContentSummary pSummary, ContentDescriptor pDescriptor, String pType, PresentationElement pParent, int pPublicationId)
public Map<String,PresentationProperty<?>> getFields()
PresentationElement
PresentationElement
that represents a summary.
If this property has zero length then the PresentationElement
represents a group or an area, not a summary.
The actual type of the Java Object
s representing the fields depends upon
field type as follows:
Field type | Java Object |
---|---|
BASIC | String |
NUMBER | a subclass of Number |
COMPLEX | Map |
BOOLEAN | Boolean |
ENUMERATION | a String or List of Strings |
URI | URI |
LINK | Link |
DATE | Date |
SCHEDULE | PresentationSchedule |
protected IOHashKey getObjectKey()
public String getType()
PresentationElement
PresentationElement
. For a PresentationElement
representing a group or area, this will be the name of the group or area definition
on which it is based. Groups and areas are defined in the layout-group
resource
file. For a PresentationElement
representing a summary, no value is returned.getType
in interface PresentationElement
public String getLabel()
PresentationElement
PresentationElement
if the
PresentationElement
representas a group or area. If the element
represents a different object, null
will be returned.
This comes from the <ui:label/>
inside the XML
element of the layout-group
resource file. If no such XML
element has been defined, the name of the element capitalised
will be retuned.getLabel
in interface PresentationElement
public PresentationElement getParent()
PresentationElement
Teaser
, ListTeaser
: The parent is always an Area
Area
: The parent is always a Group
Group
: The parent is always either an Area
or null
when the group is a
root group.PresentationElement
may not follow this rule if it is not a part of the section
page.getParent
in interface PresentationElement
PresentationElement
. If this element has no parent, then null
is
returned.public PresentationArticle getContent()
PresentationElement
PresentationElement
that represents
a summary.getContent
in interface PresentationElement
protected final int getPublicationId()
public PresentationLoader getPresentationLoader()
protected PresentationArticle getPresentationArticle()
protected final void handleOptions(Map<String,Object> pOptions, MapPropertyDescriptor pOptionsPropertyDescriptor, neo.xredsys.presentation.PresentationFieldTranslator<PropertyDescriptor> pTranslator)
© 1998- 2018 Stibo DX