cz.ponec.ppSee.api
Interface ApiAlbum

All Superinterfaces:

Api, HtmParams

public interface ApiAlbum

extends Api, HtmParams

The ApiAlbum is basic class for the using the program interface in the PPSee album templates and BSH script. The instance of the class is available by variable api.
Sample: api.getAlbum()
// the expression returns a collection of index pages.

Field Summary

Fields inherited from interface cz.ponec.ppSee.api.Api

DOCTYPE_401_STRICT, DOCTYPE_401_TRANS, DOCTYPE_X10_STRICT, DOCTYPE_X10_TRANS, NO

Fields inherited from interface cz.ponec.ppSee.api.HtmParams

BasicHtmlPage, BgColor, BgColorType, BgTextureExt, BgTextureInt, BorderColor, BorderColorSet, ColorLink, CountThumbsOfPage, CountThumbsOfPageIsRec, CpOriginalPict, DetailTooltip, DetailTooltipTxt, EApeture, EAuthor, EAuthorDiff, ECameraMake, ECameraModel, ECompressionT, EDateFormat, EDateOriginal, EDetailDescr, EExposureTime, EFileName, EFirmwareVersion, EImageNumber, EIso, EMeteringMode, EOrigPictSize, EOwnerName, ESourcePictSize, EUserDescr, EUserTitle, EVersion, FgColor, FooterText, HeaderAuthor, HeaderDate, HeaderDateFormat, HeaderDescription, HeaderLogo, HeaderLogoResize, HeaderLogoResizeS, HeaderLogoSize, HeaderLogoUrl, ImgDetailBW, ImgHqResampling, ImgSharpenD, ImgSharpenT, ImgThumbBW, JpgCompress, Language, Link2Exit, Link2ExitUrl, LinkToOriginal, MonochromeTone, MonochromeToneSet, NavigImgGroup, NavigImgLink, NavigStyle, PaddingColor, PaddingColorSet, PictResize, PictResizeS, PictSize, Separator1, Separator2, ShowFinalDescr, ShowFinalIcon, ShowIcon, ShowSlideOrder, ShowTimeInterval, SignMark, SignMarkColBg, SignMarkColFg, SignMarkSize, SlideBorderColor, SlideBorderColorSet, SlideDescription, SlideShow, SortDesc1, SortDesc2, SortDesc3, SortLevel1, SortLevel2, SortLevel3, Template, ThumbDescription, ThumbResize, ThumbResizeS, ThumbSize, ThumbTooltip, ThumbTooltipTxt, TitleColor, TransEnabled, TransTime, TransType, WriteXmlHeader

Method Summary

java.lang.Object	bsh(java.lang.String function) Returns the value from BeanShell script (see BSH Editor ).
java.lang.Object	bsh(java.lang.String function, java.lang.Object parameter) Returns the value from BeanShell script (see BSH Editor ).
Album	getAlbum() Returns a collections of Album images and index pages.
java.lang.String	getBackgroundImage(boolean topIndex) Returns Link to Texture Image (include "") or null in the case the background is not requred..
java.lang.String	getBackgroundImageCss(boolean topIndex) Returns Link to Texture Image for CSS definition.
java.lang.Object	getContext() Returns a HTML template context.
int	getCountOfFiles() Returns the Count of Files (include Images and another Files).
int	getCountOfImages() Returns the Count of Images.
java.lang.Object	getParam(Property parameterName) Returns a user parameter form the PPSee program (parameters are managed by user by graphical interface of the PPSee program).
java.io.File	getTargetDirectory() Returns the top of the tree target directories.
Util	getUtil() Returns the text utilities object.
boolean	isPreviewMode() Returns true value, if the album is created in a preview (quick) mode.
void	log(java.lang.Object message) Print the Message to standard output.
void	log(java.lang.Object message, java.lang.Throwable exception) Print the Message with an Exception to standard output.

Methods inherited from interface cz.ponec.ppSee.api.Api

formatHedader, formatMark, formatPicture, getApplName, getApplVersion, getDirDescription, getDirTitle, getDoctype, getHtmlText, getCharset, getLang, getLocale, getPoweredBy, getPoweredByText, getSourceDirectory, toHtml

Method Detail

getTargetDirectory

public java.io.File getTargetDirectory()

Returns the top of the tree target directories.

getUtil

public Util getUtil()

Returns the text utilities object.

getParam

public java.lang.Object getParam(Property parameterName)

Returns a user parameter form the PPSee program (parameters are managed by user by graphical interface of the PPSee program).

Parameters:

parameterName - Select a parameter name from HtmParams interface.

Returns:

Object Type of String, Integer, Dimension, Boolean, String[],

See Also:

HtmParams

getCountOfFiles

public int getCountOfFiles()

Returns the Count of Files (include Images and another Files).

getCountOfImages

public int getCountOfImages()

Returns the Count of Images.

bsh

public java.lang.Object bsh(java.lang.String function,
                            java.lang.Object parameter)

Returns the value from BeanShell script (see BSH Editor ). Method can be useful for creating Templates.

Parameters:

function - Name of BeanShell function.

parameter - The One Parameter of function.

Returns:

A result of BeanShell function.

bsh

public java.lang.Object bsh(java.lang.String function)

Returns the value from BeanShell script (see BSH Editor ). Method can be useful for creating Templates.

Returns:

A result of BeanShell function.

log

public void log(java.lang.Object message,
                java.lang.Throwable exception)

Print the Message with an Exception to standard output.

Specified by:

log in interface Api

log

public void log(java.lang.Object message)

Print the Message to standard output.

getAlbum

public Album getAlbum()

Returns a collections of Album images and index pages.

getContext

public java.lang.Object getContext()

Returns a HTML template context. The method returns a different object according to just used template.

Specified by:

getContext in interface Api

Returns:

• An Detail object from detail template.
• An IndexPage object from an index template.
• The Album object in other cases

isPreviewMode

public boolean isPreviewMode()

Returns true value, if the album is created in a preview (quick) mode.

getBackgroundImage

public java.lang.String getBackgroundImage(boolean topIndex)

Returns Link to Texture Image (include "") or null in the case the background is not requred..

Parameters:

topIndex -

getBackgroundImageCss

public java.lang.String getBackgroundImageCss(boolean topIndex)

Returns Link to Texture Image for CSS definition.

Parameters:

topIndex -