Method Summary |
string
|
|
string
|
|
string
|
|
TAttributeCollection
|
Returns the list of custom attributes.
|
boolean
|
|
abstract
string
|
|
boolean
|
|
THotSpotMode
|
|
string
|
|
string
|
|
abstract
string
|
|
integer
|
|
string
|
|
string
|
|
protected
mixed
|
Returns a viewstate value.
|
boolean
|
|
string
|
Removes the named attribute.
|
void
|
Renders this hotspot.
|
void
|
|
void
|
|
void
|
Sets a custom hotspot attribute.
|
void
|
|
void
|
|
void
|
|
void
|
|
void
|
|
void
|
|
void
|
|
protected
void
|
setViewState
( string $key, mixed $value, mixed $defaultValue)
Sets a viewstate value.
|
Method Details |
getAccessKey
public string getAccessKey |
() |
Output |
string
| the access key that allows you to quickly navigate to the HotSpot region. Defaults to ''. |
Exception |
|
getAlternateText
public string getAlternateText |
() |
Output |
string
| the alternate text to display for a HotSpot object. Defaults to ''. |
Exception |
|
getAttribute
public string getAttribute |
(mixed $name ) |
Input |
mixed | $name | |
Output |
string
| attribute value, null if attribute does not exist |
Exception |
|
getAttributes
Returns the list of custom attributes.
Custom attributes are name-value pairs that may be rendered as HTML tags' attributes.
|
getCausesValidation
public boolean getCausesValidation |
() |
Output |
boolean
| whether postback event trigger by this hotspot will cause input validation, default is true |
Exception |
|
getCoordinates
public abstract string getCoordinates |
() |
Output |
string
| coordinates defining the hotspot shape. |
Exception |
|
getHasAttributes
public boolean getHasAttributes |
() |
Output |
boolean
| whether the hotspot has custom attributes |
Exception |
|
getHotSpotMode
Output |
THotSpotMode
| the behavior of a HotSpot object when it is clicked. Defaults to THotSpotMode::NotSet. |
Exception |
|
getNavigateUrl
public string getNavigateUrl |
() |
Output |
string
| the URL to navigate to when a HotSpot object is clicked. Defaults to ''. |
Exception |
|
getPostBackValue
public string getPostBackValue |
() |
Output |
string
| a value that is post back when the HotSpot is clicked. Defaults to ''. |
Exception |
|
getShape
public abstract string getShape |
() |
Output |
string
| shape of the hotspot, can be 'circle', 'rect', 'poly', etc. |
Exception |
|
getTabIndex
public integer getTabIndex |
() |
Output |
integer
| the tab index of the HotSpot region. Defaults to 0. |
Exception |
|
getTarget
public string getTarget |
() |
Output |
string
| the target window or frame to display the new page when the HotSpot region is clicked. Defaults to ''. |
Exception |
|
getValidationGroup
public string getValidationGroup |
() |
Output |
string
| the group of validators which the hotspot causes validation upon postback |
Exception |
|
getViewState
protected mixed getViewState |
(string $key , mixed $defaultValue ) |
Returns a viewstate value.
This function is very useful in defining getter functions for component properties that must be kept in viewstate.
Input |
string | $key | the name of the viewstate value to be returned |
mixed | $defaultValue | the default value. If $key is not found in viewstate, $defaultValue will be returned |
Output |
mixed
| the viewstate value corresponding to $key |
Exception |
|
hasAttribute
public boolean hasAttribute |
(mixed $name ) |
Input |
mixed | $name | |
Output |
boolean
| whether the named attribute exists |
Exception |
|
removeAttribute
public string removeAttribute |
(string $name ) |
Removes the named attribute.
Input |
string | $name | the name of the attribute to be removed. |
Output |
string
| attribute value removed, null if attribute does not exist. |
Exception |
|
render
Renders this hotspot.
|
setAccessKey
public void setAccessKey |
(string $value ) |
Input |
string | $value | the access key that allows you to quickly navigate to the HotSpot region. |
Output |
Exception |
|
setAlternateText
public void setAlternateText |
(string $value ) |
Input |
string | $value | the alternate text to display for a HotSpot object. |
Output |
Exception |
|
setAttribute
public void setAttribute |
(string $name , string $value ) |
Sets a custom hotspot attribute.
Input |
string | $name | attribute name |
string | $value | value of the attribute |
Output |
Exception |
|
setCausesValidation
public void setCausesValidation |
(boolean $value ) |
Input |
boolean | $value | whether postback event trigger by this hotspot will cause input validation |
Output |
Exception |
|
setHotSpotMode
Input |
THotSpotMode | $value | the behavior of a HotSpot object when it is clicked. |
Output |
Exception |
|
setNavigateUrl
public void setNavigateUrl |
(string $value ) |
Input |
string | $value | the URL to navigate to when a HotSpot object is clicked. |
Output |
Exception |
|
setPostBackValue
public void setPostBackValue |
(string $value ) |
Input |
string | $value | a value that is post back when the HotSpot is clicked. |
Output |
Exception |
|
setTabIndex
public void setTabIndex |
(integer $value ) |
Input |
integer | $value | the tab index of the HotSpot region. |
Output |
Exception |
|
setTarget
public void setTarget |
(string $value ) |
Input |
string | $value | the target window or frame to display the new page when the HotSpot region is clicked. |
Output |
Exception |
|
setValidationGroup
public void setValidationGroup |
(string $value ) |
Input |
string | $value | the group of validators which the hotspot causes validation upon postback |
Output |
Exception |
|
setViewState
protected void setViewState |
(string $key , mixed $value , mixed $defaultValue ) |
Sets a viewstate value.
This function is very useful in defining setter functions for control properties that must be kept in viewstate. Make sure that the viewstate value must be serializable and unserializable.
Input |
string | $key | the name of the viewstate value |
mixed | $value | the viewstate value to be set |
mixed | $defaultValue | default value. If $value===$defaultValue, the item will be cleared from the viewstate. |
Output |
Exception |
|