cz.ponec.ppSee.api
Interface Detail

public interface Detail

The representative of a detail page/file of the album. The detail file is usually an image.

Method Summary

java.awt.Dimension	getAreaDetail() Deprecated. Use getDetailArea() instead.
java.awt.Dimension	getAreaOrig() Deprecated. Use getOrigArea() instead.
java.awt.Dimension	getAreaThumbnail() Deprecated. Use getThumbnailArea() instead.
Attribute[]	getAttributes() Returns the array of attributes of the related file/image.
Note	getAuthor() Returns the Author of Image.
java.lang.Comparable	getCreated() Returns the Date of Created Image From Exif Inforamtion.
Note	getCreatedFormatted() Returns the Date of Created Image From Exif Inforamtion like formatted String.
Note	getDescription() User File Note.
java.awt.Dimension	getDetailArea() Returns the Area (in pixels) of a Detail Image.
java.lang.String	getDetailImageName() Returns the name of image for detail page.
java.lang.String	getDetailPageName() Returns the name of HTML detail page.
Note	getExif(java.lang.String key) Returns the Exif Value.
SFile	getFile() Returns the Source File (like a System File).
java.lang.String	getId() Returns the unique string for the current file.
IndexPage	getIndexPage() Returns a basic index page for the file.
Detail	getNextDetail(int step) Returns the next detail (file/image) or null in case no file was found.
java.awt.Dimension	getOrigArea() Returns the Area (in pixels) of a Original Image.
int	getPointerOfFile() Returns the pointer of the current file or -1 if the poiner was not found.
java.awt.Dimension	getThumbnailArea() Returns the Area (in pixels) of a Thumbnail Image.
java.lang.String	getThumbnailImageName() Returns the name of thumbnail image.
Note	getTitle() User File Title.
boolean	isImage() Returns the true value, if the file is an image.

Method Detail

getDescription

public Note getDescription()

User File Note.

getTitle

public Note getTitle()

User File Title.

getFile

public SFile getFile()

Returns the Source File (like a System File).

getOrigArea

public java.awt.Dimension getOrigArea()

Returns the Area (in pixels) of a Original Image.

getAreaOrig

public java.awt.Dimension getAreaOrig()

Deprecated. Use getOrigArea() instead.

Returns the Area (in pixels) of a Original Image.

getThumbnailArea

public java.awt.Dimension getThumbnailArea()

Returns the Area (in pixels) of a Thumbnail Image.

getAreaThumbnail

public java.awt.Dimension getAreaThumbnail()

Deprecated. Use getThumbnailArea() instead.

Returns the Area (in pixels) of a Thumbnail Image.

getDetailArea

public java.awt.Dimension getDetailArea()

Returns the Area (in pixels) of a Detail Image.

getAreaDetail

public java.awt.Dimension getAreaDetail()

Deprecated. Use getDetailArea() instead.

Returns the Area (in pixels) of a Detail Image .

Returns:

Dimesion in pixels.

getAuthor

public Note getAuthor()

Returns the Author of Image.

getCreated

public java.lang.Comparable getCreated()

Returns the Date of Created Image From Exif Inforamtion.

Returns:

Type of Result is java.util.Date if it is possible, else the result has got a String type .

getCreatedFormatted

public Note getCreatedFormatted()

Returns the Date of Created Image From Exif Inforamtion like formatted String.

isImage

public boolean isImage()

Returns the true value, if the file is an image.

getExif

public Note getExif(java.lang.String key)

Returns the Exif Value.

Parameters:

key - A String hexadecimal number of exif value (sample: "0x0110") or an exif key (sample: "Owner Name").

Returns:

a String value if Exif information.

getDetailPageName

public java.lang.String getDetailPageName()

Returns the name of HTML detail page.

getDetailImageName

public java.lang.String getDetailImageName()

Returns the name of image for detail page.

getThumbnailImageName

public java.lang.String getThumbnailImageName()

Returns the name of thumbnail image.

getPointerOfFile

public int getPointerOfFile()

Returns the pointer of the current file or -1 if the poiner was not found.

getNextDetail

public Detail getNextDetail(int step)

Returns the next detail (file/image) or null in case no file was found.

Parameters:

step - Step to new file. Value +1 means a next file, value -1 means a previous detail.

Returns:

Neighbouring detail object.

getIndexPage

public IndexPage getIndexPage()

Returns a basic index page for the file.

getId

public java.lang.String getId()

Returns the unique string for the current file.

getAttributes

public Attribute[] getAttributes()

Returns the array of attributes of the related file/image.