PHP Class Prado\Web\UI\WebControls\THotSpot

THotSpot implements the basic functionality common to all hot spot shapes. Derived classes include {@link TCircleHotSpot}, {@link TPolygonHotSpot} and {@link TRectangleHotSpot}.
Since: 3.0
Author: Qiang Xue ([email protected])
Inheritance: extends Prado\TComponent
Afficher le fichier Open project: pradosoft/prado

Méthodes publiques

Méthode Description
getAccessKey ( ) : string
getAlternateText ( ) : string
getAttribute ( $name ) : string
getAttributes ( ) : TAttributeCollection Returns the list of custom attributes.
getCausesValidation ( ) : boolean
getCoordinates ( ) : string
getHasAttributes ( ) : boolean
getHotSpotMode ( ) : THotSpotMode
getNavigateUrl ( ) : string
getPostBackValue ( ) : string
getShape ( ) : string
getTabIndex ( ) : integer
getTarget ( ) : string
getValidationGroup ( ) : string
hasAttribute ( $name ) : boolean
removeAttribute ( $name ) : string Removes the named attribute.
render ( $writer ) Renders this hotspot.
setAccessKey ( $value )
setAlternateText ( $value )
setAttribute ( $name, $value ) Sets a custom hotspot attribute.
setCausesValidation ( $value )
setHotSpotMode ( $value )
setNavigateUrl ( $value )
setPostBackValue ( $value )
setTabIndex ( $value )
setTarget ( $value )
setValidationGroup ( $value )

Méthodes protégées

Méthode Description
getViewState ( $key, $defaultValue = null ) : mixed Returns a viewstate value.
setViewState ( $key, $value, $defaultValue = null ) Sets a viewstate value.

Method Details

getAccessKey() public méthode

public getAccessKey ( ) : string
Résultat string the access key that allows you to quickly navigate to the HotSpot region. Defaults to ''.

getAlternateText() public méthode

public getAlternateText ( ) : string
Résultat string the alternate text to display for a HotSpot object. Defaults to ''.

getAttribute() public méthode

public getAttribute ( $name ) : string
Résultat string attribute value, null if attribute does not exist

getAttributes() public méthode

Custom attributes are name-value pairs that may be rendered as HTML tags' attributes.
public getAttributes ( ) : TAttributeCollection
Résultat Prado\Collections\TAttributeCollection the list of custom attributes

getCausesValidation() public méthode

public getCausesValidation ( ) : boolean
Résultat boolean whether postback event trigger by this hotspot will cause input validation, default is true

getCoordinates() abstract public méthode

abstract public getCoordinates ( ) : string
Résultat string coordinates defining the hotspot shape.

getHasAttributes() public méthode

public getHasAttributes ( ) : boolean
Résultat boolean whether the hotspot has custom attributes

getHotSpotMode() public méthode

public getHotSpotMode ( ) : THotSpotMode
Résultat THotSpotMode the behavior of a HotSpot object when it is clicked. Defaults to THotSpotMode::NotSet.

getNavigateUrl() public méthode

public getNavigateUrl ( ) : string
Résultat string the URL to navigate to when a HotSpot object is clicked. Defaults to ''.

getPostBackValue() public méthode

public getPostBackValue ( ) : string
Résultat string a value that is post back when the HotSpot is clicked. Defaults to ''.

getShape() abstract public méthode

abstract public getShape ( ) : string
Résultat string shape of the hotspot, can be 'circle', 'rect', 'poly', etc.

getTabIndex() public méthode

public getTabIndex ( ) : integer
Résultat integer the tab index of the HotSpot region. Defaults to 0.

getTarget() public méthode

public getTarget ( ) : string
Résultat string the target window or frame to display the new page when the HotSpot region is clicked. Defaults to ''.

getValidationGroup() public méthode

public getValidationGroup ( ) : string
Résultat string the group of validators which the hotspot causes validation upon postback

getViewState() protected méthode

This function is very useful in defining getter functions for component properties that must be kept in viewstate.
protected getViewState ( $key, $defaultValue = null ) : mixed
Résultat mixed the viewstate value corresponding to $key

hasAttribute() public méthode

public hasAttribute ( $name ) : boolean
Résultat boolean whether the named attribute exists

removeAttribute() public méthode

Removes the named attribute.
public removeAttribute ( $name ) : string
Résultat string attribute value removed, null if attribute does not exist.

render() public méthode

Renders this hotspot.
public render ( $writer )

setAccessKey() public méthode

public setAccessKey ( $value )

setAlternateText() public méthode

public setAlternateText ( $value )

setAttribute() public méthode

Sets a custom hotspot attribute.
public setAttribute ( $name, $value )

setCausesValidation() public méthode

public setCausesValidation ( $value )

setHotSpotMode() public méthode

public setHotSpotMode ( $value )

setNavigateUrl() public méthode

public setNavigateUrl ( $value )

setPostBackValue() public méthode

public setPostBackValue ( $value )

setTabIndex() public méthode

public setTabIndex ( $value )

setTarget() public méthode

public setTarget ( $value )

setValidationGroup() public méthode

public setValidationGroup ( $value )

setViewState() protected méthode

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.
protected setViewState ( $key, $value, $defaultValue = null )