CAnnotationDisplay Class Reference

Generate HTML code to display annotations. More...

Inheritance diagram for CAnnotationDisplay:

CAnnotationBase List of all members.

Public Member Functions

 CAnnotationDisplay ()
 getJavascript ()
 getStyles ()
 flag_replaceLinks ($replace=0)
 flag_showhideBar ($show=1)
 flag_autoAlt ($autoalt=0)
 flag_showCallouts ($show_callouts=1)
 replaceLinks ($text)
 _getImageHTML ($src, $parser, $attributes)
 getAnnotatedImageFromString ($src, $xml_string, $attributes="")
 getAnnotatedImageFromFile ($src, $path, $attributes="")
 getAnnotatedImageFromObject ($src, $parser, $attributes="")

Public Attributes

 $autoalt = 0
 $replace_links = 0
 $showhidebar = 1
 $show_callouts = 1

Detailed Description

Generate HTML code to display annotations.

Display annotations on images. Creating HTML code to put into your own pages


Constructor & Destructor Documentation

CAnnotationDisplay::CAnnotationDisplay  ) 
 

Constructor. Initialing object.


Member Function Documentation

CAnnotationDisplay::flag_autoAlt autoalt = 0  ) 
 

Turn on/off auto set ALT attribute of IMG tag If turned on, all annotations' text will be copied into ALT attribute of IMG tag of the appropriate image.

Text for alt - caption of image

Parameters:
$autoalt 1 - Turn on, 0 - Turn off

CAnnotationDisplay::flag_replaceLinks replace = 0  ) 
 

Turn on/off links (http, www, mailto) replacements into hrefs. If turned on, all occurences of http, www, mailto in your annotations will be replaced with clickable hyperlinks for example http://www.fototagger.com will be replaced with <<

Parameters:
$replace 1 - Turn on, 0 - Turn off

CAnnotationDisplay::flag_showCallouts show_callouts = 1  ) 
 

Turn on/off display callouts if it exists (lines, arrows, etc)

Parameters:
$show_callouts 1 (default) - Turn on, 0 - Turn off

CAnnotationDisplay::flag_showhideBar show = 1  ) 
 

Turn on/off show bottom show/hide annotation toolbar and arrow

Parameters:
$show 1 - Turn on, 0 - Turn off

CAnnotationDisplay::getAnnotatedImageFromFile src,
path,
attributes = ""
 

Generates HTML code for an image containing annotations.

Parameters:
$src Path to image to put into IMG SRC tag
$path Local path to jpeg image
$attributes Additional attributes to insert info IMG tag
Returns:
String with HTML code

CAnnotationDisplay::getAnnotatedImageFromObject src,
parser,
attributes = ""
 

Generates HTML code for an image with annotations supplied in CAnnotationParser object.

Parameters:
$src Path to image to put into IMG SRC tag
$parser CAnnotationParser object with annotations already parsed
$attributes Additional attributes to insert info IMG tag
Returns:
String with HTML code

CAnnotationDisplay::getAnnotatedImageFromString src,
xml_string,
attributes = ""
 

Generates HTML code for an image with annotations supplied as a string.

Parameters:
$src Path to image to put into IMG SRC tag
$xml_string XML with annotations
$attributes Additional attributes to insert info IMG tag
Returns:
String with HTML code

CAnnotationDisplay::getJavascript  ) 
 

Return javascript required for hide/display annotations on image

Returns:
String. You can call this function from anywhere on your page, before the code displaying annotatated image.

CAnnotationDisplay::getStyles  ) 
 

Return CSS styles to insert into your own page

Returns:
String. Put in any like place of your page.


The documentation for this class was generated from the following file:
Generated on Fri Jul 28 12:50:53 2006 for FotoTaggerWebAPI by  doxygen 1.4.6-NO