|
Class THyperLink
THyperLink class
THyperLink displays a hyperlink on a page. The hyperlink URL is specified via
the setNavigateUrl NavigateUrl property, and link text is via the setText Text property. It is also possible to display an image by setting the
setImageUrl ImageUrl property. In this case, the alignment of the image
displayed is set by the setImageAlign ImageAlign property and getText Text is displayed as the alternate text of the image.
The link target is specified via the setTarget Target property. If
both getImageUrl ImageUrl and getText Text are empty, the
content enclosed within the control tag will be rendered.
-
TComponent
-
TApplicationComponent
-
TControl
implements
IRenderable,
IBindable
-
TWebControl
implements
IStyleable
-
THyperLink
implements
IDataRenderer
Methods summary
protected
string
|
#
getTagName( )
Returns
string tag name of the hyperlink
Overrides
|
protected
|
#
addAttributesToRender( THtmlWriter $writer )
Adds attributes related to a hyperlink element to renderer.
Adds attributes related to a hyperlink element to renderer.
Parameters
- $writer
THtmlWriter
the writer used for the rendering purpose
Overrides
|
public
|
#
renderContents( THtmlWriter $writer )
Renders the body content of the hyperlink.
Renders the body content of the hyperlink.
Parameters
Overrides
|
protected
TImage
|
#
createImage( string $imageUrl )
Gets the TImage for rendering the ImageUrl property. This is not for creating
dynamic images.
Gets the TImage for rendering the ImageUrl property. This is not for creating
dynamic images.
Parameters
- $imageUrl
string image url.
Returns
TImage
image control for rendering.
|
public
string
|
#
getText( )
Returns
string the text caption of the THyperLink
|
public
|
#
setText( string $value )
Sets the text caption of the THyperLink.
Sets the text caption of the THyperLink.
Parameters
- $value
string the text caption to be set
|
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
|
#
getImageHeight( )
Returns
string height of the image in the THyperLink
|
public
|
#
setImageHeight( string $value )
Sets the height of the image in the THyperLink
Sets the height of the image in the THyperLink
Parameters
- $value
string height of the image in the THyperLink
|
public
string
|
#
getImageUrl( )
Returns
string the location of the image file for the THyperLink
|
public
|
#
setImageUrl( string $value )
Sets the location of image file of the THyperLink.
Sets the location of image file of the THyperLink.
Parameters
- $value
string the image file location
|
public
string
|
#
getImageWidth( )
Returns
string width of the image in the THyperLink
|
public
|
#
setImageWidth( string $value )
Sets the width of the image in the THyperLink
Sets the width of the image in the THyperLink
Parameters
- $value
string width of the image
|
public
string
|
#
getNavigateUrl( )
Returns
string the URL to link to when the THyperLink component is clicked.
|
public
|
#
setNavigateUrl( string $value )
Sets the URL to link to when the THyperLink component is clicked.
Sets the URL to link to when the THyperLink component is clicked.
Parameters
|
public
string
|
#
getData( )
Returns the URL to link to when the THyperLink component is clicked. This
method is required by IDataRenderer . It is the same as THyperLink::getText() .
Returns
string the text caption
Since
3.1.0
See
Implementation of
|
public
|
#
setData( string $value )
Sets the URL to link to when the THyperLink component is clicked. This method
is required by IDataRenderer . It is the same as THyperLink::setText() .
Parameters
- $value
string the text caption to be set
Since
3.1.0
See
Implementation of
|
public
string
|
#
getTarget( )
Returns
string the target window or frame to display the Web page content linked to when the
THyperLink component is clicked.
|
public
|
#
setTarget( string $value )
Sets the target window or frame to display the Web page content linked to
when the THyperLink component is clicked.
Sets the target window or frame to display the Web page content linked to
when the THyperLink component is clicked.
Parameters
- $value
string the target window, valid values include '_blank', '_parent', '_self', '_top' and
empty string.
|
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
|
|