cz.ponec.ppSee.api
Interface Api

All Known Subinterfaces:

ApiAlbum

public interface Api

The Api is basic class for the using the program interface in the PPSee general templates and BSH script. The instance of the class is available by variable api.
Sample: api.getAuthor()
// the expression returns a name of the current album author.

Field Summary

static java.lang.String	DOCTYPE_401_STRICT Standard doctype HTML 4.01 Strict.
static java.lang.String	DOCTYPE_401_TRANS Standard doctype HTML 4.01 Transitional.
static java.lang.String	DOCTYPE_X10_STRICT Standard doctype XHTML 1.0 Strict.
static java.lang.String	DOCTYPE_X10_TRANS Standard doctype XHTML 1.0 Transitional.
static java.lang.String	NO A sign for an invalid string.

Method Summary

Note	formatHedader(java.util.Date date) Formats the date for index header.
java.lang.String	formatMark(java.util.Date date) Formats the date as Mark.
Note	formatPicture(java.util.Date date) Formats the date for for Picture.
java.lang.String	getApplName() Returns PPSee name
java.lang.String	getApplVersion() PPSee version
java.lang.Object	getContext() Returns a context.
Note	getDirDescription() Returns a Descripton of the current directory
Note	getDirTitle() Returns a title of the current directory
java.lang.String	getDoctype(java.lang.String doctype) Returns a HTML doctype and a XML specification (in case, the specification is required).
java.lang.String	getHtmlText(Note aNote) Deprecated.
java.lang.String	getCharset() Returns a charset.
java.lang.String	getLang() Get the current language.
java.util.Locale	getLocale() Returns the user selected Language Locale.
Note	getPoweredBy() Returns the language text "Powered by PPSee" include a HTML tags.
Note	getPoweredByText() Returns the unformatted language text "Powered by PPSee".
java.io.File	getSourceDirectory() Returns the current directory.
void	log(java.lang.Object message, java.lang.Throwable exception) Print the Message with an Exception to standard output.
java.lang.String	toHtml(java.lang.String text) Convert the special character to HTML format.

Field Detail

NO

public static final java.lang.String NO

A sign for an invalid string. (The real value is an empty string). The constant can be useful for a void JavaScript parameters.

See Also:

Constant Field Values

DOCTYPE_401_STRICT

public static final java.lang.String DOCTYPE_401_STRICT

Standard doctype HTML 4.01 Strict.

See Also:

Constant Field Values

DOCTYPE_401_TRANS

public static final java.lang.String DOCTYPE_401_TRANS

Standard doctype HTML 4.01 Transitional.

See Also:

Constant Field Values

DOCTYPE_X10_STRICT

public static final java.lang.String DOCTYPE_X10_STRICT

Standard doctype XHTML 1.0 Strict.

See Also:

Constant Field Values

DOCTYPE_X10_TRANS

public static final java.lang.String DOCTYPE_X10_TRANS

Standard doctype XHTML 1.0 Transitional.

See Also:

Constant Field Values

Method Detail

getSourceDirectory

public java.io.File getSourceDirectory()

Returns the current directory.

getDirTitle

public Note getDirTitle()

Returns a title of the current directory

getDirDescription

public Note getDirDescription()

Returns a Descripton of the current directory

toHtml

public java.lang.String toHtml(java.lang.String text)

Convert the special character to HTML format.

getLocale

public java.util.Locale getLocale()

Returns the user selected Language Locale.

getLang

public java.lang.String getLang()

Get the current language.

log

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

Print the Message with an Exception to standard output.

getContext

public java.lang.Object getContext()

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

getCharset

public java.lang.String getCharset()

Returns a charset.

formatHedader

public Note formatHedader(java.util.Date date)

Formats the date for index header.

formatPicture

public Note formatPicture(java.util.Date date)

Formats the date for for Picture.

formatMark

public java.lang.String formatMark(java.util.Date date)

Formats the date as Mark.

getApplVersion

public java.lang.String getApplVersion()

PPSee version

getApplName

public java.lang.String getApplName()

Returns PPSee name

getHtmlText

public java.lang.String getHtmlText(Note aNote)

Deprecated.

Convert a Note text to HTML friendly text. Apply a bsh script (if any).

getPoweredByText

public Note getPoweredByText()

Returns the unformatted language text "Powered by PPSee".

getPoweredBy

public Note getPoweredBy()

Returns the language text "Powered by PPSee" include a HTML tags.

getDoctype

public java.lang.String getDoctype(java.lang.String doctype)

Returns a HTML doctype and a XML specification (in case, the specification is required).