cz.ponec.ppSee.api
Interface Util

public interface Util

Text Utilities of API. The class provides a language texts for HTML page. The text result of the methodo have got a true codepage.

Field Summary

static java.lang.String	SHOW Slide Show HTML File Name.
static java.lang.String	SHOW_INTRO Intro Slide Show HTML File Name.

Method Summary

java.lang.String	getApplName() Deprecated. See Api.getApplName()
Note	getButtonTagIndex() Get a Button Tag for an Index page.
Note	getButtonTagMenu() Get a Button Tag for a Menu page.
Note	getButtonTagNext() Get a Button Tag for a next page.
Note	getButtonTagPrev() Get a Button Tag for a previous page.
Note	getButtonTagShow() Get a Button Tag for a slide show page.
java.lang.String	getCharset() Deprecated. See Api.getCharset()
Note	getKeyNameEsc() Returns the Language Note of a Key Escape.
Note	getKeyNameLeft() Returns the Language Note of a Key Cursor Left.
Note	getKeyNameRight() Returns the Language Note of a Key Cursor Right.
Note	getKeyNameSpace() Returns the Language Note of a Key Space Bar.
java.lang.String	getLink2Css() Return the Link to CSS.
java.lang.String	getLink2Css(java.lang.String prefix) Return the Link to CSS:
Note	getPoweredBy() Returns the language text "Powered by PPSee" include a HTML tags.
Note	getPoweredByText() Returns the unformatted language text "Powered by PPSee".
java.awt.Color	getSimilarColor_(java.awt.Color color, int ratio) Returns a similar Color.
java.lang.String	getSimilarColor(java.lang.String color) Returns a similar Color by default color ratio (12%).
java.lang.String	getSimilarColor(java.lang.String color, int ratio) Returns a similar Color
Note	getText(java.lang.String key) Return the language text form a text properties file.
Note	getText(java.lang.String key, java.lang.String param) Return the HTML language text form appropriate text properties file by a key and parameter.
java.lang.String	getVersion() Deprecated. See Api.getApplVersion()

Field Detail

SHOW_INTRO

public static final java.lang.String SHOW_INTRO

Intro Slide Show HTML File Name.

See Also:

Constant Field Values

SHOW

public static final java.lang.String SHOW

Slide Show HTML File Name.

See Also:

Constant Field Values

Method Detail

getText

public Note getText(java.lang.String key)

Return the language text form a text properties file.

getText

public Note getText(java.lang.String key,
                    java.lang.String param)

Return the HTML language text form appropriate text properties file by a key and parameter.

getCharset

public java.lang.String getCharset()

Deprecated. See Api.getCharset()

Returns the CodePage of HTML pages.

getApplName

public java.lang.String getApplName()

Deprecated. See Api.getApplName()

Returns the Application name.

getVersion

public java.lang.String getVersion()

Deprecated. See Api.getApplVersion()

Returns the current version of the Application.

getLink2Css

public java.lang.String getLink2Css()

Return the Link to CSS.

getLink2Css

public java.lang.String getLink2Css(java.lang.String prefix)

Return the Link to CSS:

Parameters:

prefix - You can set a prefix to a general directory. If you set a null value, function returns a standard relative path.

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.

getKeyNameLeft

public Note getKeyNameLeft()

Returns the Language Note of a Key Cursor Left.

Returns:

A Text Key Label closed inside "square brackets" [].

getKeyNameRight

public Note getKeyNameRight()

Returns the Language Note of a Key Cursor Right.

Returns:

A Text Key Label closed inside "square brackets" [].

getKeyNameEsc

public Note getKeyNameEsc()

Returns the Language Note of a Key Escape.

Returns:

A Text Key Label closed inside "square brackets" [].

getKeyNameSpace

public Note getKeyNameSpace()

Returns the Language Note of a Key Space Bar.

Returns:

A Text Key Label closed inside "square brackets" [].

getButtonTagPrev

public Note getButtonTagPrev()

Get a Button Tag for a previous page.

getButtonTagNext

public Note getButtonTagNext()

Get a Button Tag for a next page.

getButtonTagMenu

public Note getButtonTagMenu()

Get a Button Tag for a Menu page.

getButtonTagIndex

public Note getButtonTagIndex()

Get a Button Tag for an Index page.

getButtonTagShow

public Note getButtonTagShow()

Get a Button Tag for a slide show page.

getSimilarColor

public java.lang.String getSimilarColor(java.lang.String color)

Returns a similar Color by default color ratio (12%).

Parameters:

color - the source color

getSimilarColor

public java.lang.String getSimilarColor(java.lang.String color,
                                        int ratio)

Returns a similar Color

Parameters:

color - the source color

ratio - The strength of change (1-100)%

getSimilarColor_

public java.awt.Color getSimilarColor_(java.awt.Color color,
                                       int ratio)

Returns a similar Color.

Parameters:

color - the source color

ratio - The strength of change (0-100)%