ContentBox Core API 1.5.7

contentbox.model.content
Class CustomHTML

WEB-INF.cftags.component
        extended by contentbox.model.content.CustomHTML

public class CustomHTML
extends WEB-INF.cftags.component

******************************************************************************* ContentBox - A Modular Content Platform Copyright 2012 by Luis Majano and Ortus Solutions, Corp www.gocontentbox.org | www.luismajano.com | www.ortussolutions.com ******************************************************************************* Apache License, Version 2.0 Copyright Since [2012] [Luis Majano and Ortus Solutions,Corp] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. ******************************************************************************* I model a custom HTML content piece


Constructor Summary
init()
          constructor
 
Method Summary
 any GETCACHE()
 any GETCACHEBOX()
 any GETCACHELASTACCESSTIMEOUT()
 any GETCACHETIMEOUT()
 any GETCONTENT()
 any GETCONTENTID()
 any GETCREATEDDATE()
 any GETCREATOR()
 any GETDESCRIPTION()
 any GETEXPIREDATE()
 any GETINTERCEPTORSERVICE()
 any GETISPUBLISHED()
 any GETMARKUP()
 any GETPOPULATOR()
 any GETPUBLISHEDDATE()
 any GETRENDEREDCONTENT()
 any GETSETTINGSERVICE()
 any GETSLUG()
 any GETTITLE()
 boolean HASCREATOR()
 void SETCACHE(any cache)
 void SETCACHEBOX(any cachebox)
 void SETCACHELASTACCESSTIMEOUT(any cacheLastAccessTimeout)
 void SETCACHETIMEOUT(any cacheTimeout)
 void SETCONTENT(any content)
 void SETCREATEDDATE(any createdDate)
 void SETCREATOR(any creator)
 void SETDESCRIPTION(any description)
 void SETEXPIREDATE(any expireDate)
 void SETINTERCEPTORSERVICE(any interceptorService)
 void SETISPUBLISHED(any isPublished)
 void SETMARKUP(any markup)
 void SETPOPULATOR(any populator)
 void SETPUBLISHEDDATE(any publishedDate)
 void SETRENDEREDCONTENT(any renderedContent)
 void SETSETTINGSERVICE(any settingService)
 void SETSLUG(any slug)
 void SETTITLE(any title)
 any addExpiredTime(any hour, any minute)
          add expired timestamp to property
 any addPublishedTime(any hour, any minute)
          add published timestamp to property
 string buildContentCacheKey()
          Build content cache keys according to sent content object
 boolean canCacheContent()
          Verify we can do content caching on this content object using global and local rules
 string getCreatorEmail()
          Shorthand Creator email
 string getCreatorName()
          Shorthand Creator name
 string getDisplayCreatedDate()
          Get formatted createdDate
 string getDisplayPublishedDate()
          Get display publishedDate
 string getExpireDateForEditor([boolean showTime='false'])
          Get display expireDate
 any getMemento()
          Get memento representation
 string getPublishedDateForEditor([boolean showTime='false'])
          Get display publishedDate
 boolean isContentPublished()
          Bit that denotes if the content has been published or not
 boolean isExpired()
          Bit that denotes if the content has expired or not, in order to be expired the content must have been published as well
 boolean isLoaded()
          is Loaded
 boolean isPublishedInFuture()
          Bit that denotes if the content has been published or not in the future
 void preInsert()
 CustomHTML prepareForClone(any author, any original, any originalService, boolean publish)
          Wipe primary key, and descendant keys, and prepare for cloning of entire hierarchies
 any renderContent()
          Render content out
 any renderContentSilent([any content='[runtime expression]'])
          Renders the content silently so no caching, or extra fluff is done, just content translation rendering
 array validate()
 
Methods inherited from class WEB-INF.cftags.component
 

Constructor Detail

init

public init()
constructor

Method Detail

GETCACHE

public any GETCACHE()


GETCACHEBOX

public any GETCACHEBOX()


GETCACHELASTACCESSTIMEOUT

public any GETCACHELASTACCESSTIMEOUT()


GETCACHETIMEOUT

public any GETCACHETIMEOUT()


GETCONTENT

public any GETCONTENT()


GETCONTENTID

public any GETCONTENTID()


GETCREATEDDATE

public any GETCREATEDDATE()


GETCREATOR

public any GETCREATOR()


GETDESCRIPTION

public any GETDESCRIPTION()


GETEXPIREDATE

public any GETEXPIREDATE()


GETINTERCEPTORSERVICE

public any GETINTERCEPTORSERVICE()


GETISPUBLISHED

public any GETISPUBLISHED()


GETMARKUP

public any GETMARKUP()


GETPOPULATOR

public any GETPOPULATOR()


GETPUBLISHEDDATE

public any GETPUBLISHEDDATE()


GETRENDEREDCONTENT

public any GETRENDEREDCONTENT()


GETSETTINGSERVICE

public any GETSETTINGSERVICE()


GETSLUG

public any GETSLUG()


GETTITLE

public any GETTITLE()


HASCREATOR

public boolean HASCREATOR()


SETCACHE

public void SETCACHE(any cache)

Parameters:
cache

SETCACHEBOX

public void SETCACHEBOX(any cachebox)

Parameters:
cachebox

SETCACHELASTACCESSTIMEOUT

public void SETCACHELASTACCESSTIMEOUT(any cacheLastAccessTimeout)

Parameters:
cacheLastAccessTimeout

SETCACHETIMEOUT

public void SETCACHETIMEOUT(any cacheTimeout)

Parameters:
cacheTimeout

SETCONTENT

public void SETCONTENT(any content)

Parameters:
content

SETCREATEDDATE

public void SETCREATEDDATE(any createdDate)

Parameters:
createdDate

SETCREATOR

public void SETCREATOR(any creator)

Parameters:
creator

SETDESCRIPTION

public void SETDESCRIPTION(any description)

Parameters:
description

SETEXPIREDATE

public void SETEXPIREDATE(any expireDate)

Parameters:
expireDate

SETINTERCEPTORSERVICE

public void SETINTERCEPTORSERVICE(any interceptorService)

Parameters:
interceptorService

SETISPUBLISHED

public void SETISPUBLISHED(any isPublished)

Parameters:
isPublished

SETMARKUP

public void SETMARKUP(any markup)

Parameters:
markup

SETPOPULATOR

public void SETPOPULATOR(any populator)

Parameters:
populator

SETPUBLISHEDDATE

public void SETPUBLISHEDDATE(any publishedDate)

Parameters:
publishedDate

SETRENDEREDCONTENT

public void SETRENDEREDCONTENT(any renderedContent)

Parameters:
renderedContent

SETSETTINGSERVICE

public void SETSETTINGSERVICE(any settingService)

Parameters:
settingService

SETSLUG

public void SETSLUG(any slug)

Parameters:
slug

SETTITLE

public void SETTITLE(any title)

Parameters:
title

addExpiredTime

public any addExpiredTime(any hour, any minute)
add expired timestamp to property

Parameters:
hour
minute

addPublishedTime

public any addPublishedTime(any hour, any minute)
add published timestamp to property

Parameters:
hour
minute

buildContentCacheKey

public string buildContentCacheKey()
Build content cache keys according to sent content object


canCacheContent

public boolean canCacheContent()
Verify we can do content caching on this content object using global and local rules


getCreatorEmail

public string getCreatorEmail()
Shorthand Creator email


getCreatorName

public string getCreatorName()
Shorthand Creator name


getDisplayCreatedDate

public string getDisplayCreatedDate()
Get formatted createdDate


getDisplayPublishedDate

public string getDisplayPublishedDate()
Get display publishedDate


getExpireDateForEditor

public string getExpireDateForEditor([boolean showTime='false'])
Get display expireDate

Parameters:
showTime

getMemento

public any getMemento()
Get memento representation


getPublishedDateForEditor

public string getPublishedDateForEditor([boolean showTime='false'])
Get display publishedDate

Parameters:
showTime

isContentPublished

public boolean isContentPublished()
Bit that denotes if the content has been published or not


isExpired

public boolean isExpired()
Bit that denotes if the content has expired or not, in order to be expired the content must have been published as well


isLoaded

public boolean isLoaded()
is Loaded


isPublishedInFuture

public boolean isPublishedInFuture()
Bit that denotes if the content has been published or not in the future


preInsert

public void preInsert()


prepareForClone

public CustomHTML prepareForClone(any author, any original, any originalService, boolean publish)
Wipe primary key, and descendant keys, and prepare for cloning of entire hierarchies

Parameters:
author - The author doing the cloning
original - The original content object that will be cloned into this content object
originalService - The ContentBox content service object used
publish - Publish pages or leave as drafts

renderContent

public any renderContent()
Render content out


renderContentSilent

public any renderContentSilent([any content='[runtime expression]'])
Renders the content silently so no caching, or extra fluff is done, just content translation rendering.

Parameters:
content - The content markup to translate, by default it uses the active content version's content

validate

public array validate()


ContentBox Core API 1.5.7