Summary: Field | Method | Constr Detail: Field | Method | Constr

Swat.SwatImagePreviewDisplay

/Swat/SwatImagePreviewDisplay.php at line 18

Class SwatImagePreviewDisplay

SwatObject
 └─SwatUIObject
    └─SwatWidget
       └─SwatControl
          └─SwatImageDisplay
             └─SwatImagePreviewDisplay

public class SwatImagePreviewDisplay
extends SwatImageDisplay

Image preview display control

This control displays an image and uses a lightbox-like effect to display another image when the first image is clicked.

Copyright:: 2005-2008 silverorange
License:: http://www.gnu.org/copyleft/lesser.html LGPL License 2.1

Field Summary
integer	$preview_height Preview Image height.
string	$preview_image Preview Image.
array	$preview_image_values Optional array of values to substitute into the preview image property.
integer	$preview_width Preview Image width.

Fields inherited from Swat.SwatImageDisplay
alt, height, image, occupy_height, occupy_width, title, values, width

Constructor Summary
SwatImagePreviewDisplay(string id) Creates a new image preview display.

Constructor Summary

SwatImagePreviewDisplay(string id)

Creates a new image preview display.

Method Summary
void	display() Displays this image.
protected array	getCSSClassNames() Gets the array of CSS classes that are applied to this image display.
protected string	getInlineJavaScript() Gets inline JavaScript required by this image preview.

Method Summary

void

display()

Displays this image.

protected array

getCSSClassNames()

Gets the array of CSS classes that are applied to this image display.

protected string

getInlineJavaScript()

Gets inline JavaScript required by this image preview.

Methods inherited from Swat.SwatImageDisplay
display, getCSSClassNames

Methods inherited from Swat.SwatControl
addMessage, getNote, printWidgetTree

Methods inherited from Swat.SwatWidget
addCompositeWidget, addMessage, confirmCompositeWidgets, copy, createCompositeWidgets, display, displayHtmlHeadEntries, getCSSClassNames, getCompositeWidget, getCompositeWidgets, getFocusableHtmlId, getHtmlHeadEntrySet, getMessages, hasMessage, init, isDisplayed, isInitialized, isProcessed, isSensitive, printWidgetTree, process, replaceWithContainer

Methods inherited from Swat.SwatUIObject
addComment, addJavaScript, addStyleSheet, addTangoAttribution, copy, getCSSClassNames, getCSSClassString, getFirstAncestor, getHtmlHeadEntrySet, getInlineJavaScript, getUniqueId, isVisible

Field Detail

/Swat/SwatImagePreviewDisplay.php at line 52

preview_height

public integer $preview_height = null

Preview Image height

The height attribute in the XHTML img tag.

/Swat/SwatImagePreviewDisplay.php at line 29

preview_image

public string $preview_image

Preview Image

The src attribute in the XHTML img tag.

/Swat/SwatImagePreviewDisplay.php at line 43

preview_image_values

public array $preview_image_values = array()

Optional array of values to substitute into the preview image property

Uses vsprintf() syntax, for example:

<?php $my_image->preview_image = 'mydir/%s.%s'; $my_image->preview_image_values = array('myfilename', 'ext'); ?>

/Swat/SwatImagePreviewDisplay.php at line 61

preview_width

public integer $preview_width = null

Preview Image width

The width attribute in the XHTML img tag.

Constructor Detail

/Swat/SwatImagePreviewDisplay.php at line 73

SwatImagePreviewDisplay

public SwatImagePreviewDisplay(string id)

Creates a new image preview display

Parameters:: id - a non-visible unique id for this widget.
See Also:: SwatWidget::__construct()

Method Detail

/Swat/SwatImagePreviewDisplay.php at line 99

display

public void display()

Displays this image

/Swat/SwatImagePreviewDisplay.php at line 152

getCSSClassNames

protected array getCSSClassNames()

Gets the array of CSS classes that are applied to this image display

Returns:: the array of CSS classes that are applied to this image display.
See Also:: SwatUIObject::getCSSClassString()

/Swat/SwatImagePreviewDisplay.php at line 130

getInlineJavaScript

protected string getInlineJavaScript()