## Class TImage

Description

Implements interfaces:

- IDataRenderer

TImage class

TImage displays an image on a page. The image is specified via the ImageUrl property which takes a relative or absolute URL to the image file. The alignment of the image displayed is set by the ImageAlign property. To set alternative texts or long description of the image, use AlternateText or DescriptionUrl property, respectively.

- since: 3.0
- version: $Id: TImage.php 2230 2007-09-18 12:21:12Z xue $
- author: Qiang Xue <qiang.xue@gmail.com>

Located in /Web/UI/WebControls/TImage.php (line 28)

    TComponent
       |
       --TApplicationComponent
          |
          --TControl
             |
             --TWebControl
                |
                --TImage

Direct descendents

Class | Description
--- | ---
TActiveImage | TActiveImage class.
TCaptcha | TCaptcha class.
TImageButton | TImageButton class
TImageMap | TImageMap class

Method Summary
void addAttributesToRender (THtmlWriter $writer)
string getAlternateText ()
string getData ()
string getDescriptionUrl ()
string getImageAlign ()
string getImageUrl ()
string getTagName ()
void renderContents (THtmlWriter $writer)
void setAlternateText (string $value)
void setData (string $value)
void setDescriptionUrl (string $value)
void setImageAlign (string $value)
void setImageUrl (string $value)
Methods
addAttributesToRender (line 42)

Adds attributes related to an HTML image element to renderer.

- access: protected

void addAttributesToRender (THtmlWriter $writer)

- THtmlWriter $writer: the writer used for the rendering purpose

Redefinition of:

TWebControl::addAttributesToRender()
  Adds attribute name-value pairs to renderer.

Redefined in descendants as:

- TImageButton::addAttributesToRender() : Adds attribute name-value pairs to renderer.
- TActiveImageButton::addAttributesToRender() : Ensure that the ID attribute is rendered and registers the javascript code for initializing the active control.
- TImageMap::addAttributesToRender() : Adds attribute name-value pairs to renderer.

getAlternateText (line 65)

- return: the alternative text displayed in the TImage component when the image is unavailable.
- access: public

string getAlternateText ()
getData (line 123)

Returns the URL of the image file.

This method is required by IDataRenderer. It is the same as getImageUrl().

- return: the URL of the image file.
- access: public
- since: 3.1.0
- see: TImage::getImageUrl()

string getData ()
getDescriptionUrl (line 144)

- return: the URL to long description
- access: public

string getDescriptionUrl ()
getImageAlign (line 82)

- return: the alignment of the image with respective to other elements on the page, defaults to empty.
- access: public

string getImageAlign ()
getImageUrl (line 102)

- return: the URL of the image file
- access: public

string getImageUrl ()
getTagName (line 33)

- return: tag name of image control
- access: protected

string getTagName ()

Redefinition of:

TWebControl::getTagName()
  Returns the tag name used for this control.

Redefined in descendants as:

- TImageButton::getTagName()

renderContents (line 58)

Renders the body content of the image.

Nothing to be rendered within image tags.

- access: public

void renderContents (THtmlWriter $writer)

- THtmlWriter $writer: the writer for rendering

Redefinition of:

TWebControl::renderContents()
  Renders the body content enclosed between the control tag.

Redefined in descendants as:

- TImageButton::renderContents() : Renders the body content enclosed between the control tag.

setAlternateText (line 74)

Sets the alternative text to be displayed in the TImage when the image is unavailable.

- access: public

void setAlternateText (string $value)

- string $value: the alternative text

Redefined in descendants as:

- TActiveImage::setAlternateText() : Sets the alternative text to be displayed in the TImage when the image is unavailable.
- TActiveImageButton::setAlternateText() : Sets the alternative text to be displayed in the TImage when the image is unavailable.

setData (line 136)

Sets the URL of the image.

This method is required by IDataRenderer. It is the same as setImageUrl().

- access: public
- since: 3.1.0
- see: TImage::setImageUrl()

void setData (string $value)

- string $value: the URL of the image file.

setDescriptionUrl (line 152)

- access: public

void setDescriptionUrl (string $value)

- string $value: the URL to the long description of the image.

Redefined in descendants as:

- TActiveImage::setDescriptionUrl()
- TActiveImageButton::setDescriptionUrl()

setImageAlign (line 94)

Sets the alignment of the image with respective to other elements on the page.

Possible values include: absbottom, absmiddle, baseline, bottom, left, middle, right, texttop, and top. If an empty string is passed in, imagealign attribute will not be rendered.

- access: public

void setImageAlign (string $value)

- string $value: the alignment of the image

Redefined in descendants as:

- TActiveImage::setImageAlign() : Sets the alignment of the image with respective to other elements on the page.
- TActiveImageButton::setImageAlign() : Sets the alignment of the image with respective to other elements on the page.

setImageUrl (line 110)

- access: public

void setImageUrl (string $value)

- string $value: the URL of the image file

Redefined in descendants as:

- TActiveImage::setImageUrl()
- TActiveImageButton::setImageUrl()

#### Inherited Methods

Inherited From TWebControl

> TWebControl::addAttributesToRender()
> TWebControl::clearStyle()
> TWebControl::copyBaseAttributes()
> TWebControl::createStyle()
> TWebControl::getAccessKey()
> TWebControl::getBackColor()
> TWebControl::getBorderColor()
> TWebControl::getBorderStyle()
> TWebControl::getBorderWidth()
> TWebControl::getCssClass()
> TWebControl::getDisplay()
> TWebControl::getFont()
> TWebControl::getForeColor()
> TWebControl::getHasStyle()
> TWebControl::getHeight()
> TWebControl::getStyle()
> TWebControl::getTabIndex()
> TWebControl::getTagName()
> TWebControl::getToolTip()
> TWebControl::getWidth()
> TWebControl::render()
> TWebControl::renderBeginTag()
> TWebControl::renderContents()
> TWebControl::renderEndTag()
> TWebControl::setAccessKey()
> TWebControl::setBackColor()
> TWebControl::setBorderColor()
> TWebControl::setBorderStyle()
> TWebControl::setBorderWidth()
> TWebControl::setCssClass()
> TWebControl::setDisplay()
> TWebControl::setForeColor()
> TWebControl::setHeight()
> TWebControl::setStyle()
> TWebControl::setTabIndex()
> TWebControl::setToolTip()
> TWebControl::setWidth()

Inherited From TControl

> TControl::__construct()
> TControl::addedControl()
> TControl::addParsedObject()
> TControl::addToPostDataLoader()
> TControl::applyStyleSheetSkin()
> TControl::autoBindProperty()
> TControl::autoDataBindProperties()
> TControl::bindProperty()
> TControl::broadcastEvent()
> TControl::bubbleEvent()
> TControl::clearChildState()
> TControl::clearControlState()
> TControl::clearNamingContainer()
> TControl::clearViewState()
> TControl::convertUniqueIdToClientId()
> TControl::createChildControls()
> TControl::createControlCollection()
> TControl::dataBind()
> TControl::dataBindChildren()
> TControl::dataBindProperties()
> TControl::ensureChildControls()
> TControl::findControl()
> TControl::findControlsByID()
> TControl::findControlsByType()
> TControl::focus()
> TControl::getAdapter()
> TControl::getAllowChildControls()
> TControl::getAttribute()
> TControl::getAttributes()
> TControl::getChildControlsCreated()
> TControl::getClientID()
> TControl::getControls()
> TControl::getControlStage()
> TControl::getControlState()
> TControl::getCustomData()
> TControl::getEnabled()
> TControl::getEnableTheming()
> TControl::getEnableViewState()
> TControl::getHasAdapter()
> TControl::getHasAttributes()
> TControl::getHasChildInitialized()
> TControl::getHasControls()
> TControl::getHasInitialized()
> TControl::getHasLoaded()
> TControl::getHasLoadedPostData()
> TControl::getHasPreRendered()
> TControl::getID()
> TControl::getNamingContainer()
> TControl::getPage()
> TControl::getParent()
> TControl::getRegisteredObject()
> TControl::getSkinID()
> TControl::getSourceTemplateControl()
> TControl::getTemplateControl()
> TControl::getUniqueID()
> TControl::getViewState()
> TControl::getVisible()
> TControl::hasAttribute()
> TControl::initRecursive()
> TControl::isDescendentOf()
> TControl::isObjectRegistered()
> TControl::loadRecursive()
> TControl::loadState()
> TControl::loadStateRecursive()
> TControl::onDataBinding()
> TControl::onInit()
> TControl::onLoad()
> TControl::onPreRender()
> TControl::onUnload()
> TControl::preRenderRecursive()
> TControl::raiseBubbleEvent()
> TControl::registerObject()
> TControl::removeAttribute()
> TControl::removedControl()
> TControl::render()
> TControl::renderChildren()
> TControl::renderControl()
> TControl::saveState()
> TControl::saveStateRecursive()
> TControl::setAdapter()
> TControl::setAttribute()
> TControl::setChildControlsCreated()
> TControl::setControlStage()
> TControl::setControlState()
> TControl::setCustomData()
> TControl::setEnabled()
> TControl::setEnableTheming()
> TControl::setEnableViewState()
> TControl::setID()
> TControl::setPage()
> TControl::setSkinID()
> TControl::setTemplateControl()
> TControl::setViewState()
> TControl::setVisible()
> TControl::trackViewState()
> TControl::traverseChildControls()
> TControl::unbindProperty()
> TControl::unloadRecursive()
> TControl::unregisterObject()
> TControl::__get()

Inherited From TApplicationComponent

> TApplicationComponent::getApplication()
> TApplicationComponent::getRequest()
> TApplicationComponent::getResponse()
> TApplicationComponent::getService()
> TApplicationComponent::getSession()
> TApplicationComponent::getUser()
> TApplicationComponent::publishAsset()
> TApplicationComponent::publishFilePath()

Inherited From TComponent

> TComponent::addParsedObject()
> TComponent::attachEventHandler()
> TComponent::canGetProperty()
> TComponent::canSetProperty()
> TComponent::createdOnTemplate()
> TComponent::detachEventHandler()
> TComponent::evaluateExpression()
> TComponent::evaluateStatements()
> TComponent::getEventHandlers()
> TComponent::getSubProperty()
> TComponent::hasEvent()
> TComponent::hasEventHandler()
> TComponent::hasProperty()
> TComponent::raiseEvent()
> TComponent::setSubProperty()
> TComponent::__get()
> TComponent::__set()

Class Constants

#### Inherited Constants

Inherited from TControl

> TControl::AUTOMATIC_ID_PREFIX
> TControl::CLIENT_ID_SEPARATOR
> TControl::CS_CHILD_INITIALIZED
> TControl::CS_CONSTRUCTED
> TControl::CS_INITIALIZED
> TControl::CS_LOADED
> TControl::CS_PRERENDERED
> TControl::CS_STATE_LOADED
> TControl::ID_FORMAT
> TControl::ID_SEPARATOR
> TControl::IS_CHILD_CREATED
> TControl::IS_CREATING_CHILD
> TControl::IS_DISABLE_THEMING
> TControl::IS_DISABLE_VIEWSTATE
> TControl::IS_ID_SET
> TControl::IS_SKIN_APPLIED
> TControl::IS_STYLESHEET_APPLIED
> TControl::RF_ADAPTER
> TControl::RF_AUTO_BINDINGS
> TControl::RF_CHILD_STATE
> TControl::RF_CONTROLS
> TControl::RF_CONTROLSTATE
> TControl::RF_DATA_BINDINGS
> TControl::RF_EVENTS
> TControl::RF_NAMED_CONTROLS
> TControl::RF_NAMED_CONTROLS_ID
> TControl::RF_NAMED_OBJECTS
> TControl::RF_SKIN_ID

Documentation generated on Mon, 21 Apr 2008 11:35:13 -0400 by phpDocumentor 1.3.0RC4