Package com.terminalfour.publish.api.content

Interface IElementAPI

All Superinterfaces:

T4PublishAPI

public interface IElementAPI
extends T4PublishAPI

Publish API for accessing element in the content item being published.

Method Summary

Modifier and Type	Method	Description
PDElement	get(String name)	Gets the element with the provided name.
PDDateTime	getDate(String name)
ImageDimensions	getImageDimensions(String name)
Map<String,Object>	getLink(String name)
List<Map<String,Object>>	getList(PDList list)
List<Map<String,Object>>	getList(String name)
int	getMediaId(String name)
List<Map<String,Object>>	getSelected(PDList list)
List<Map<String,Object>>	getSelected(String name)
long	getSize(String name)
boolean	isDateElement(String name)
boolean	isFileElement(String name)
boolean	isImage(String name)
boolean	isMediaElement(String name)
boolean	isSet(String name)
boolean	isTagElement(String name)
String	publish(String name)

Method Detail

get

PDElement get(String name)

Gets the element with the provided name.

Parameters:

name - The name of the element.

Returns:

A reference to the element or PDElement#NOT_FOUND if the element does not exist or cannot be found.

isSet

boolean isSet(String name)

publish

String publish(String name)

getSize

long getSize(String name)

isFileElement

boolean isFileElement(String name)

isImage

boolean isImage(String name)

isTagElement

boolean isTagElement(String name)

isDateElement

boolean isDateElement(String name)

isMediaElement

boolean isMediaElement(String name)

getImageDimensions

ImageDimensions getImageDimensions(String name)

getList

List<Map<String,Object>> getList(String name)

getList

List<Map<String,Object>> getList(PDList list)

getSelected

List<Map<String,Object>> getSelected(String name)

getSelected

List<Map<String,Object>> getSelected(PDList list)

getLink

Map<String,Object> getLink(String name)

getDate

PDDateTime getDate(String name)

getMediaId

int getMediaId(String name)