Module com.semanticcms.core.taglib

Package com.semanticcms.core.taglib

Class Functions

java.lang.Object

com.semanticcms.core.taglib.Functions

public final class Functions
extends Object

Tag library function implementations.

Method Summary

Modifier and Type	Method	Description
static Page	captureContentRoot(String level)
static Page	capturePage(String page, String level)
static Page	capturePageInBook(String book, String page, String level)
static Double	ceil(Double a)
static List<Page>	convertPageDagToList(Page rootPage, String level)
static String	encodeUrlParam(String value)	Deprecated, for removal: This API element is subject to removal in a future version. Please use URIEncoder.encodeURIComponent(java.lang.String) instead.
static List<? extends Element>	filterElements(Page page, String elementType)
static boolean	findAllowRobots(Page page)
static Set<Author>	findAuthors(Page page)
static Copyright	findCopyright(Page page)
static List<?>	findTopLevelElements(Node node, String elementType)
static Double	floor(Double a)
static Book	getBook(String pagePath)
static String	getCaptureLevel()	Gets the current capture level or null if not currently capturing.
static File	getExeFile(String path)
static File	getExeFileInBook(String book, String path)
static File	getFile(String path, boolean requireFile)
static File	getFileInBook(String book, String path, boolean requireFile)
static String	getLinkCssClass(Element element)
static PageIndex	getPageIndex(PageRef pageRef)
static String	getRefId(String id)
static String	getRefIdInPage(Page page, String id)
static boolean	getViewAllowRobots(View view, Page page)
static Set<Author>	getViewAuthors(View view, Page page)
static Copyright	getViewCopyright(View view, Page page)
static String	getViewLinkCssClass(View view)
static Map<String,List<String>>	getViewLinkParams(View view, Page page)
static Collection<Link>	getViewLinks(View view, Page page)
static String	getViewTitle(View view, Page page)
static boolean	hasElement(Page page, String elementType, boolean recursive)
static boolean	isExporting()
static boolean	isViewApplicable(View view, Page page)
static Map<String,String>	mergeGlobalAndViewScripts(View view)
static Map<String,String>	parseQueryString(String queryString)
static String	repeat(String value, int count)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

capturePageInBook

public static Page capturePageInBook(String book,
 String page,
 String level)
                              throws ServletException,
IOException

Throws:

ServletException

IOException

capturePage

public static Page capturePage(String page,
 String level)
                        throws ServletException,
IOException

Throws:

ServletException

IOException

captureContentRoot

public static Page captureContentRoot(String level)
                               throws ServletException,
IOException

Throws:

ServletException

IOException

getPageIndex

public static PageIndex getPageIndex(PageRef pageRef)
                              throws ServletException,
IOException

Throws:

ServletException

IOException

convertPageDagToList

public static List<Page> convertPageDagToList(Page rootPage,
 String level)
                                       throws ServletException,
IOException

Throws:

ServletException

IOException

getCaptureLevel

public static String getCaptureLevel()

Gets the current capture level or null if not currently capturing.

See Also:

• CaptureLevel

getFileInBook

public static File getFileInBook(String book,
 String path,
 boolean requireFile)
                          throws ServletException,
IOException

Throws:

ServletException

IOException

getFile

public static File getFile(String path,
 boolean requireFile)
                    throws ServletException,
IOException

Throws:

ServletException

IOException

getExeFileInBook

public static File getExeFileInBook(String book,
 String path)
                             throws ServletException,
IOException

Throws:

ServletException

IOException

getExeFile

public static File getExeFile(String path)
                       throws ServletException,
IOException

Throws:

ServletException

IOException

encodeUrlParam

@Deprecated(forRemoval=true)
public static String encodeUrlParam(String value)

Deprecated, for removal: This API element is subject to removal in a future version.

Please use URIEncoder.encodeURIComponent(java.lang.String) instead.

getRefId

public static String getRefId(String id)
                       throws ServletException

Throws:

ServletException

getRefIdInPage

public static String getRefIdInPage(Page page,
 String id)

ceil

public static Double ceil(Double a)

floor

public static Double floor(Double a)

parseQueryString

public static Map<String,String> parseQueryString(String queryString)

repeat

public static String repeat(String value,
 int count)

getBook

public static Book getBook(String pagePath)

isExporting

public static boolean isExporting()

findCopyright

public static Copyright findCopyright(Page page)
                               throws ServletException,
IOException

Throws:

ServletException

IOException

findAuthors

public static Set<Author> findAuthors(Page page)
                               throws ServletException,
IOException

Throws:

ServletException

IOException

findAllowRobots

public static boolean findAllowRobots(Page page)
                               throws ServletException,
IOException

Throws:

ServletException

IOException

hasElement

public static boolean hasElement(Page page,
 String elementType,
 boolean recursive)
                          throws ServletException,
IOException,
ClassNotFoundException

Throws:

ServletException

IOException

ClassNotFoundException

findTopLevelElements

public static List<?> findTopLevelElements(Node node,
 String elementType)
                                    throws ClassNotFoundException

Throws:

ClassNotFoundException

filterElements

public static List<? extends Element> filterElements(Page page,
 String elementType)
                                              throws ClassNotFoundException

Throws:

ClassNotFoundException

isViewApplicable

public static boolean isViewApplicable(View view,
 Page page)
                                throws ServletException,
IOException

Throws:

ServletException

IOException

getViewLinkCssClass

public static String getViewLinkCssClass(View view)

getViewLinkParams

public static Map<String,List<String>> getViewLinkParams(View view,
 Page page)

getViewCopyright

public static Copyright getViewCopyright(View view,
 Page page)
                                  throws ServletException,
IOException

Throws:

ServletException

IOException

getViewAuthors

public static Set<Author> getViewAuthors(View view,
 Page page)
                                  throws ServletException,
IOException

Throws:

ServletException

IOException

getViewTitle

public static String getViewTitle(View view,
 Page page)

getViewLinks

public static Collection<Link> getViewLinks(View view,
 Page page)
                                     throws ServletException,
IOException

Throws:

ServletException

IOException

getViewAllowRobots

public static boolean getViewAllowRobots(View view,
 Page page)
                                  throws ServletException,
IOException

Throws:

ServletException

IOException

getLinkCssClass

public static String getLinkCssClass(Element element)

mergeGlobalAndViewScripts

public static Map<String,String> mergeGlobalAndViewScripts(View view)