com.openedit.page
Class Page

java.lang.Object
  com.openedit.page.Page

All Implemented Interfaces:

java.lang.Comparable, Data

public class Page
extends java.lang.Object
implements Data, java.lang.Comparable

Field Summary

static java.lang.String

BLANK_LAYOUT

Constructor Summary

Page()

Page(Page inPage)

Page(java.lang.String inPath, PageSettings inMetaData)

Method Summary

int	compareTo(java.lang.Object inO)
void	debug(java.lang.String inMessage)
boolean	exists()
java.util.List	fieldGenerators()
java.lang.String	findInnerLayout()
WebPageRequest	generate(WebPageRequest inReq, Output inOut)
void	generate(WebPageRequest inWebPageContext, java.io.Writer inOutputStream) This will contain innerlayout details
java.lang.String	get(java.lang.String name) Get the named property.
java.lang.String	getAlternateContentPath()
java.lang.String	getCharacterEncoding()
java.lang.String	getContent()
ContentItem	getContentItem()
java.lang.String	getDirectory()
java.lang.String	getDirectoryName()
java.lang.String	getDirectoryRoot()
java.util.List	getGenerator()
java.lang.String	getId()
java.lang.String	getInnerLayout()
java.io.InputStream	getInputStream()
java.util.Date	getLastModified()
java.lang.String	getLastModified(java.lang.String inDateFormat) DOCME
java.lang.String	getLayout()
java.lang.String	getMimeType() DOCME
java.lang.String	getName()
java.util.List	getPageActions() Get a List of page actions.
java.lang.String	getPageName()
PageSettings	getPageSettings()
java.lang.String	getParentPath()
java.util.List	getParentPaths()
java.lang.String	getPath() Get the request path.
java.util.List	getPathActions() Get a List of page actions.
Permission	getPermission(java.lang.String inName)
java.util.List	getPermissions()
java.util.Map	getProperties()
java.lang.String	getProperty(java.lang.String name) Get the named page property using the default Locale.
java.lang.String	getProperty(java.lang.String name, java.util.Locale language) Get the Locale-specific value for the given named property.
java.lang.String	getProperty(java.lang.String name, java.lang.String language)
java.io.Reader	getReader()
java.lang.String	getSourcePath()
java.lang.String	getText(java.lang.String inKey, java.lang.String inLocale)
boolean	hasInnerLayout()
boolean	hasLayout()
boolean	isBinary()
boolean	isCurrent() This is asking if the settings have been changed under it
boolean	isDraft()
boolean	isFolder()
boolean	isHtml()
boolean	isImage()
boolean	isPropertyTrue(java.lang.String inKey)
long	lastModified()
long	length()
void	setContentItem(ContentItem revision)
void	setId(java.lang.String inNewid)
void	setName(java.lang.String inName)
void	setPageSettings(PageSettings inSettings)
void	setProperty(java.lang.String inId, java.lang.String inValue)
void	setSourcePath(java.lang.String inSourcepath)
java.lang.String	toString() DOCME

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

BLANK_LAYOUT

public static final java.lang.String BLANK_LAYOUT

See Also:

Constant Field Values

Constructor Detail

Page

public Page(java.lang.String inPath,
            PageSettings inMetaData)

Page

public Page()

Page

public Page(Page inPage)

Method Detail

isBinary

public boolean isBinary()

isFolder

public boolean isFolder()

exists

public boolean exists()

getLastModified

public java.util.Date getLastModified()

lastModified

public long lastModified()

isCurrent

public boolean isCurrent()

This is asking if the settings have been changed under it

Returns:

getLastModified

public java.lang.String getLastModified(java.lang.String inDateFormat)

DOCME

Parameters:

inDateFormat - DOCME

Returns:

DOCME

getMimeType

public java.lang.String getMimeType()

DOCME

Returns:

DOCME

getPageActions

public java.util.List getPageActions()

Get a List of page actions. To add an action to the page just add the action to this List. Page actions are triggered each time the page is requested.

Returns:

A List of page actions

getPathActions

public java.util.List getPathActions()

Get a List of page actions. To add an action to the page just add the action to this List. Page actions are triggered each time the page is requested.

Returns:

A List of page actions

getPath

public java.lang.String getPath()

Get the request path.

Returns:

The request path

getDirectory

public java.lang.String getDirectory()

getDirectoryName

public java.lang.String getDirectoryName()

getDirectoryRoot

public java.lang.String getDirectoryRoot()

getName

public java.lang.String getName()

Specified by:

getName in interface Data

getPageName

public java.lang.String getPageName()

getProperty

public java.lang.String getProperty(java.lang.String name)

Get the named page property using the default Locale. If the property is not found then return null.

Parameters:

name - The property name

Returns:

The value or null

getProperty

public java.lang.String getProperty(java.lang.String name,
                                    java.lang.String language)

getProperty

public java.lang.String getProperty(java.lang.String name,
                                    java.util.Locale language)

Get the Locale-specific value for the given named property. If the property is not found then return null. This method will try to find the most suitable locale by searching the property values in the following manner:

language + "_" + country + "_" + variant
language + "_" + country
langauge
""

Parameters:

name - The property name

locale - The locale

Returns:

The value

debug

public void debug(java.lang.String inMessage)

get

public java.lang.String get(java.lang.String name)

Get the named property. This method is equivilent to the getProperty(name) method. This method is provided as a convenience to Velocity code.

Specified by:

get in interface Data

Parameters:

name - The property name

Returns:

The value

isPropertyTrue

public boolean isPropertyTrue(java.lang.String inKey)

toString

public java.lang.String toString()

DOCME

Overrides:

toString in class java.lang.Object

Returns:

DOCME

setPageSettings

public void setPageSettings(PageSettings inSettings)

getPageSettings

public PageSettings getPageSettings()

getAlternateContentPath

public java.lang.String getAlternateContentPath()

Returns:

fieldGenerators

public java.util.List fieldGenerators()

getGenerator

public java.util.List getGenerator()

Returns:

getInputStream

public java.io.InputStream getInputStream()
                                   throws ContentNotAvailableException

Throws:

ContentNotAvailableException

getLayout

public java.lang.String getLayout()

Returns:

getInnerLayout

public java.lang.String getInnerLayout()

findInnerLayout

public java.lang.String findInnerLayout()

hasLayout

public boolean hasLayout()

hasInnerLayout

public boolean hasInnerLayout()

getContentItem

public ContentItem getContentItem()

setContentItem

public void setContentItem(ContentItem revision)

getReader

public java.io.Reader getReader()
                         throws OpenEditException

Throws:

OpenEditException

getCharacterEncoding

public java.lang.String getCharacterEncoding()

getContent

public java.lang.String getContent()
                            throws OpenEditException

Throws:

OpenEditException

generate

public WebPageRequest generate(WebPageRequest inReq,
                               Output inOut)
                        throws OpenEditException

Parameters:

inReq -

Throws:

OpenEditException

generate

public void generate(WebPageRequest inWebPageContext,
                     java.io.Writer inOutputStream)

This will contain innerlayout details

Parameters:

inWebPageContext -

inOutputStream -

isHtml

public boolean isHtml()

Returns:

isImage

public boolean isImage()

isDraft

public boolean isDraft()

getPermission

public Permission getPermission(java.lang.String inName)

getPermissions

public java.util.List getPermissions()

getParentPaths

public java.util.List getParentPaths()

getId

public java.lang.String getId()

Specified by:

getId in interface Data

getParentPath

public java.lang.String getParentPath()

getSourcePath

public java.lang.String getSourcePath()

Specified by:

getSourcePath in interface Data

setId

public void setId(java.lang.String inNewid)

Specified by:

setId in interface Data

setName

public void setName(java.lang.String inName)

Specified by:

setName in interface Data

setProperty

public void setProperty(java.lang.String inId,
                        java.lang.String inValue)

Specified by:

setProperty in interface Data

setSourcePath

public void setSourcePath(java.lang.String inSourcepath)

Specified by:

setSourcePath in interface Data

length

public long length()

getProperties

public java.util.Map getProperties()

Specified by:

getProperties in interface Data

compareTo

public int compareTo(java.lang.Object inO)

Specified by:

compareTo in interface java.lang.Comparable

getText

public java.lang.String getText(java.lang.String inKey,
                                java.lang.String inLocale)