|
Class TImage
TImage class
TImage displays an image on a page. The image is specified via the setImageUrl ImageUrl property which takes a relative or absolute URL to the
image file. The alignment of the image displayed is set by the setImageAlign ImageAlign property. To set alternative texts or long description
of the image, use setAlternateText AlternateText or setDescriptionUrl DescriptionUrl property, respectively.
-
TComponent
-
TApplicationComponent
-
TControl
implements
IRenderable,
IBindable
-
TWebControl
implements
IStyleable
-
TImage
implements
IDataRenderer
Methods summary
protected
string
|
#
getTagName( )
Returns
string tag name of image control
Overrides
|
protected
|
#
addAttributesToRender( THtmlWriter $writer )
Adds attributes related to an HTML image element to renderer.
Adds attributes related to an HTML image element to renderer.
Parameters
- $writer
THtmlWriter
the writer used for the rendering purpose
Overrides
|
public
|
#
renderContents( THtmlWriter $writer )
Renders the body content of the image. Nothing to be rendered within image
tags.
Renders the body content of the image. Nothing to be rendered within image
tags.
Parameters
Overrides
|
public
string
|
#
getAlternateText( )
Returns
string the alternative text displayed in the TImage component when the image is
unavailable.
|
public
|
#
setAlternateText( string $value )
Sets the alternative text to be displayed in the TImage when the image is
unavailable.
Sets the alternative text to be displayed in the TImage when the image is
unavailable.
Parameters
- $value
string the alternative text
|
public
string
|
#
getImageAlign( )
Returns
string the alignment of the image with respective to other elements on the page,
defaults to empty.
|
public
|
#
setImageAlign( string $value )
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.
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.
Parameters
- $value
string the alignment of the image
|
public
string
|
#
getImageUrl( )
Returns
string the URL of the image file
|
public
|
#
setImageUrl( string $value )
Parameters
- $value
string the URL of the image file
|
public
string
|
#
getData( )
Returns the URL of the image file. This method is required by IDataRenderer . It is the same as TImage::getImageUrl() .
Returns
string the URL of the image file.
Since
3.1.0
See
Implementation of
|
public
|
#
setData( string $value )
Sets the URL of the image. This method is required by IDataRenderer .
It is the same as TImage::setImageUrl() .
Parameters
- $value
string the URL of the image file.
Since
3.1.0
See
Implementation of
|
public
string
|
#
getDescriptionUrl( )
Returns
string the URL to long description
|
public
|
#
setDescriptionUrl( string $value )
Parameters
- $value
string the URL to the long description of the image.
|
Methods inherited from TWebControl
clearStyle(),
copyBaseAttributes(),
createStyle(),
getAccessKey(),
getBackColor(),
getBorderColor(),
getBorderStyle(),
getBorderWidth(),
getCssClass(),
getDecorator(),
getDisplay(),
getEnsureId(),
getFont(),
getForeColor(),
getHasStyle(),
getHeight(),
getStyle(),
getTabIndex(),
getToolTip(),
getWidth(),
onPreRender(),
render(),
renderBeginTag(),
renderEndTag(),
setAccessKey(),
setBackColor(),
setBorderColor(),
setBorderStyle(),
setBorderWidth(),
setCssClass(),
setDisplay(),
setEnsureId(),
setForeColor(),
setHeight(),
setStyle(),
setTabIndex(),
setToolTip(),
setWidth()
|
Methods inherited from TControl
__construct(),
__get(),
addParsedObject(),
addToPostDataLoader(),
addedControl(),
applyStyleSheetSkin(),
autoBindProperty(),
autoDataBindProperties(),
bindProperty(),
broadcastEvent(),
bubbleEvent(),
clearChildState(),
clearControlState(),
clearNamingContainer(),
clearViewState(),
convertUniqueIdToClientId(),
createChildControls(),
createControlCollection(),
dataBind(),
dataBindChildren(),
dataBindProperties(),
ensureChildControls(),
findControl(),
findControlsByID(),
findControlsByType(),
focus(),
getAdapter(),
getAllowChildControls(),
getAttribute(),
getAttributes(),
getChildControlsCreated(),
getClientID(),
getControlStage(),
getControlState(),
getControls(),
getCustomData(),
getEnableTheming(),
getEnableViewState(),
getEnabled(),
getHasAdapter(),
getHasAttributes(),
getHasChildInitialized(),
getHasControls(),
getHasInitialized(),
getHasLoaded(),
getHasLoadedPostData(),
getHasPreRendered(),
getID(),
getIsSkinApplied(),
getNamingContainer(),
getPage(),
getParent(),
getRegisteredObject(),
getSkinID(),
getSourceTemplateControl(),
getTemplateControl(),
getUniqueID(),
getViewState(),
getVisible(),
hasAttribute(),
initRecursive(),
isDescendentOf(),
isObjectRegistered(),
loadRecursive(),
loadState(),
loadStateRecursive(),
onDataBinding(),
onInit(),
onLoad(),
onUnload(),
preRenderRecursive(),
raiseBubbleEvent(),
registerObject(),
removeAttribute(),
removedControl(),
renderChildren(),
renderControl(),
saveState(),
saveStateRecursive(),
setAdapter(),
setAttribute(),
setChildControlsCreated(),
setControlStage(),
setControlState(),
setCustomData(),
setEnableTheming(),
setEnableViewState(),
setEnabled(),
setID(),
setPage(),
setSkinID(),
setTemplateControl(),
setViewState(),
setVisible(),
trackViewState(),
traverseChildControls(),
unbindProperty(),
unloadRecursive(),
unregisterObject()
|
Methods inherited from TComponent
__call(),
__destruct(),
__isset(),
__set(),
__sleep(),
__unset(),
__wakeup(),
asa(),
attachBehavior(),
attachBehaviors(),
attachClassBehavior(),
attachEventHandler(),
canGetProperty(),
canSetProperty(),
clearBehaviors(),
createdOnTemplate(),
detachBehavior(),
detachBehaviors(),
detachClassBehavior(),
detachEventHandler(),
disableBehavior(),
disableBehaviors(),
enableBehavior(),
enableBehaviors(),
evaluateExpression(),
evaluateStatements(),
fxAttachClassBehavior(),
fxDetachClassBehavior(),
getAutoGlobalListen(),
getBehaviorsEnabled(),
getClassHierarchy(),
getEventHandlers(),
getListeningToGlobalEvents(),
getSubProperty(),
hasEvent(),
hasEventHandler(),
hasProperty(),
isa(),
listen(),
raiseEvent(),
setSubProperty(),
unlisten()
|
Constants inherited from TControl
AUTOMATIC_ID_PREFIX,
CLIENT_ID_SEPARATOR,
CS_CHILD_INITIALIZED,
CS_CONSTRUCTED,
CS_INITIALIZED,
CS_LOADED,
CS_PRERENDERED,
CS_STATE_LOADED,
ID_FORMAT,
ID_SEPARATOR,
IS_CHILD_CREATED,
IS_CREATING_CHILD,
IS_DISABLE_THEMING,
IS_DISABLE_VIEWSTATE,
IS_ID_SET,
IS_SKIN_APPLIED,
IS_STYLESHEET_APPLIED,
RF_ADAPTER,
RF_AUTO_BINDINGS,
RF_CHILD_STATE,
RF_CONTROLS,
RF_CONTROLSTATE,
RF_DATA_BINDINGS,
RF_EVENTS,
RF_NAMED_CONTROLS,
RF_NAMED_CONTROLS_ID,
RF_NAMED_OBJECTS,
RF_SKIN_ID
|
|