Class: TImage

Source Location: /Web/UI/WebControls/TImage.php

Class Overview

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

TImage class

Class Details

[line 63]
TImage class

TImage displays an image on the page. The path to the displayed image is specified by setting the ImageUrl property, which can be a relative local file path or a URL. You can specify the text to display in place of image when the image is not available by setting the AlternateText property. The alignment of the image in relation to other elements on the Web page is specified by setting ImageAlign property.

Note, this control only displays an image. If you need to capture mouse clicks on the image, use the TImageButton or TLinkButton components.

Note, AlternateText will be HTML encoded before it is displayed in the TTextBox component. If you don't want it to be so, set EncodeText to false.

Namespace: System.Web.UI.WebControls

Properties

AlternateText, string, kept in viewstate
Gets or sets the alternate text displayed in the TImage component when the image is unavailable. Browsers that support the ToolTips feature display this text as a ToolTip.
EncodeText, boolean, default=true, kept in viewstate
Gets or sets the value indicating whether AlternateText should be HTML-encoded when rendering.
ImageAlign, string, kept in viewstate
Gets or sets the alignment of the TImage component in relation to other elements on the Web page. Valid values include 'left', 'right', 'baseline', 'top', 'middle', 'bottom', 'absbottom', 'absmiddle', 'texttop'. TImage will not check the validity of this value.
ImageUrl, string, kept in viewstate
Gets or sets the location of an image to display in the TImage component.
Border, integer, default=0, kept in viewstate
Gets or sets the border width of the TImage component.

Examples

On a page template file, insert the following line to create a TImage component,
```
   <com:TImage ImageUrl="images/logo.gif" />
```

version:	v1.0, last update on 2004/08/13 21:44:52
author:	Qiang Xue <qiang.xue@gmail.com>

[ Top ]

Methods

Child classes:

TImageButton: TImageButton class

Inherited Variables

Class: TComponent

TComponent::$children

Inherited Methods

Class: TWebControl

TWebControl::appendJavascriptEvent(): Append a javascript statement to a particular attribute, e.g. "onclick".
TWebControl::getAccessKey()
TWebControl::getAttributesToRender(): This overrides the parent implementation by rendering more TWebControl-specific attributes.
TWebControl::getBackColor()
TWebControl::getBorderColor()
TWebControl::getBorderStyle()
TWebControl::getBorderWidth()
TWebControl::getCssClass()
TWebControl::getForeColor()
TWebControl::getHeight()
TWebControl::getJavascriptEvents(): Get the list of all the javascript statements.
TWebControl::getStyle()
TWebControl::getTabIndex()
TWebControl::getToolTip()
TWebControl::getWidth()
TWebControl::isEnabled()
TWebControl::parseStyle(): Parses a CSS style string into an array representation.
TWebControl::removeJavascriptEvent(): Remove all or a particular javascript statements.
TWebControl::setAccessKey(): Sets the access key of the control.
TWebControl::setBackColor(): Sets the background color of the control
TWebControl::setBorderColor(): Sets the border color of the control
TWebControl::setBorderStyle(): Sets the border style of the control
TWebControl::setBorderWidth(): Sets the border width of the control
TWebControl::setCssClass(): Sets the CSS class name of the control
TWebControl::setEnabled(): Enables or disables a control.
TWebControl::setForeColor(): Sets the foreground color of the control
TWebControl::setHeight(): Sets the height of the control
TWebControl::setStyle(): Sets the CSS style of the control.
TWebControl::setTabIndex(): Sets the tab index of the control.
TWebControl::setToolTip(): Sets the tooltip of the control.
TWebControl::setWidth(): Sets the width of the control

Class: TControl

TControl::__construct(): Constructor.
TControl::addBody(): Appends an object into the body collection of this control.
TControl::addParsedObject(): Adds the object parsed in template as a body of the component.
TControl::allowBody(): Determines whether the control can add the object as a body.
TControl::clearViewState(): Clears viewstate
TControl::findBodyControl()
TControl::getAttribute()
TControl::getAttributes(): Returns the attribute list object.
TControl::getAttributesToRender(): Returns attributes to be rendered.
TControl::getBodies()
TControl::getClientID(): Returns the client ID of the component.
TControl::getContainer(): Returns the container of this component.
TControl::getSkinName()
TControl::getTagName()
TControl::getViewState(): Returns a viewstate value.
TControl::initSkin(): Initializes a skin for the control. If a skin name is provided then that skin will be loaded.
TControl::isViewStateEnabled()
TControl::isVisible(): This method checks whether a control is visible.
TControl::loadViewState(): Loads viewstate into this component and its children.
TControl::onBubbleEvent(): This method responds to a bubbled event.
TControl::onInit(): This method is invoked when the control enters 'Init' stage.
TControl::onInitRecursive(): Calls onInit of this control and its children recursively.
TControl::onLoad(): This method is invoked when the control enters 'Load' stage.
TControl::onLoadRecursive(): Calls onLoad of this control and its children recursively.
TControl::onPreRender(): This method is invoked when the control enters 'PreRender' stage.
TControl::onPreRenderRecursive(): Calls onPreRender of this control and its children recursively.
TControl::onUnload(): This method is invoked when the control enters 'Unload' stage.
TControl::onUnloadRecursive(): Calls onUnload of this control and its children recursively.
TControl::raiseBubbleEvent(): Invokes the parent's onBubbleEvent method.
TControl::removeBodies(): Removes all body content.
TControl::render(): Renders this control.
TControl::renderAttributes(): Renders the attributes.
TControl::renderBody(): Renders the body content.
TControl::saveViewState(): Returns the viewstate of this component and its children.
TControl::setAttribute(): Sets an attribute.
TControl::setContainer(): Sets the container of this component
TControl::setEnableViewState()
TControl::setSkinName(): Sets the skin to use for this control
TControl::setTagName(): Sets the tag name.
TControl::setViewState(): Sets a viewstate value.
TControl::setVisible()
TControl::synchronizeControl(): This method should only be used by framework developer.

Class: TComponent

TComponent::__construct(): Constructor.
TComponent::addChild(): Adds a child component.
TComponent::addParsedObject(): Handles a component or string met in template.
TComponent::attachEventHandler(): Attaches a handler function to an event.
TComponent::bindProperty(): Sets up the binding between a property and an expression.
TComponent::canGetProperty(): Determines whether a property can be read.
TComponent::canSetProperty(): Determines whether a property can be written.
TComponent::createComponent(): Creates a child component.
TComponent::dataBind(): Performs the databinding for this component.
TComponent::evaluateExpression(): Evaluates a PHP expression.
TComponent::evaluateStatements(): Evaluates a list of PHP statements.
TComponent::findObject(): Finds an object by its ID path.
TComponent::getApplication()
TComponent::getChild()
TComponent::getChildren()
TComponent::getDefinition(): Returns or builds a component definition.
TComponent::getGlobalization(): Returns the Globalization instance for the application.
TComponent::getID()
TComponent::getModule(): Returns the module object that contains the component or the page containing the component.
TComponent::getPage()
TComponent::getParent()
TComponent::getPropertyInitValue(): Gets the initial value of a property.
TComponent::getPropertyType(): Returns the type of a property
TComponent::getRequest(): Returns the request object associated with application.
TComponent::getServiceManager(): Returns the service manager for this application.
TComponent::getSession(): Returns the session object associated with the application.
TComponent::getSessionState(): Returns a session variable.
TComponent::getUniqueID(): Returns the unique ID of the component.
TComponent::getUser(): Returns the user object associated with the application.
TComponent::hasChildren()
TComponent::hasEvent(): Determines whether an event is defined.
TComponent::hasProperty(): Determines whether a property is defined.
TComponent::initProperties(): Initializes the property values.
TComponent::instantiateTemplate(): Parses a template string and instantiates the content.
TComponent::onDataBinding(): This method is invoked when dataBind is invoked for the component.
TComponent::raiseEvent(): Invokes all attached event handler functions for a particular event.
TComponent::removeChild(): Removes a child component.
TComponent::removeChildren(): Removes all child components.
TComponent::setAttribute(): Sets an attribute.
TComponent::setDefinition(): Sets a component definition.
TComponent::setID(): Sets a component ID.
TComponent::setParent(): Sets the parent of this component.
TComponent::setPropertyInitValue(): Sets the initial value of a property.
TComponent::setRoot(): Sets the root component in the component hierarchy.
TComponent::setSessionState(): Sets a session variable.
TComponent::unbindProperty(): Breaks the binding between a property and an expression.
TComponent::__get(): Returns a property value by name or a child component by ID.
TComponent::__set(): Sets value of a component property.

Class Methods

constructor __construct [line 69]

TImage __construct(
)

Constructor.

Sets TagName property to 'img'.

access:

public

Overridden in child classes as:

TImageButton::__construct(): Constructor.

Overrides TControl::__construct() (Constructor.)

[ Top ]

method allowBody [line 80]

boolean allowBody(
mixed
$object)

Overrides parent implementation to disable body addition.

access:

public

Overridden in child classes as:

TImageButton::allowBody(): Overrides parent implementation to disable body addition.

Overrides TControl::allowBody() (Determines whether the control can add the object as a body.)

Parameters:

mixed

$object

the object to be added

[ Top ]

method getAlternateText [line 88]

string getAlternateText(
)

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

[ Top ]

method getAttributesToRender [line 174]

ArrayObject getAttributesToRender(
)

This overrides the parent implementation by rendering more TImage-specific attributes.

return:	the attributes to be rendered
access:	protected

Overridden in child classes as:

TImageButton::getAttributesToRender(): This overrides the parent implementation by rendering more TImageButton-specific attributes.

Overrides TWebControl::getAttributesToRender() (This overrides the parent implementation by rendering more TWebControl-specific attributes.)

[ Top ]

method getBorder [line 156]

integer getBorder(
)

return:	the border width of the image rendered by the TImage component.
access:	public

[ Top ]

method getImageAlign [line 122]

string getImageAlign(
)

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

[ Top ]

method getImageUrl [line 139]

string getImageUrl(
)

return:	the location of the image file to be displayed
access:	public

[ Top ]

method isEncodeText [line 105]

boolean isEncodeText(
)

return:	whether AlternateText should be HTML encoded before rendering
access:	public

[ Top ]

method setAlternateText [line 97]

void setAlternateText(
string
$value)

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

access:

public

Parameters:

string

$value

the alternative text

[ Top ]

method setBorder [line 165]

void setBorder(
integer
$value)

Sets the border width of the image rendered by the TImage component.

access:

public

Parameters:

integer

$value

the border width

[ Top ]

method setEncodeText [line 114]

void setEncodeText(
boolean
$value)

Sets the value indicating whether AlternateText should be HTML encoded before rendering

access:

public

Parameters:

boolean

$value

whether the text should be HTML encoded before rendering

[ Top ]

method setImageAlign [line 131]

void setImageAlign(
string
$value)

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

access:

public

Parameters:

string

$value

the alignment of the image

[ Top ]

method setImageUrl [line 148]

void setImageUrl(
string
$value)

Sets the location of the image file to be displayed.

access:

public

Parameters:

string

$value

the location of the image file (file path or URL)

[ Top ]