PHP Класс 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}.
С версии: 3.0
Автор: Qiang Xue ([email protected])
Наследование: extends Prado\TComponent
Показать файл Открыть проект

Открытые методы

Метод Описание
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 )

Защищенные методы

Метод Описание
getViewState ( $key, $defaultValue = null ) : mixed Returns a viewstate value.
setViewState ( $key, $value, $defaultValue = null ) Sets a viewstate value.

Описание методов

getAccessKey() публичный Метод

public getAccessKey ( ) : string
Результат string the access key that allows you to quickly navigate to the HotSpot region. Defaults to ''.

getAlternateText() публичный Метод

public getAlternateText ( ) : string
Результат string the alternate text to display for a HotSpot object. Defaults to ''.

getAttribute() публичный Метод

public getAttribute ( $name ) : string
Результат string attribute value, null if attribute does not exist

getAttributes() публичный Метод

Custom attributes are name-value pairs that may be rendered as HTML tags' attributes.
public getAttributes ( ) : TAttributeCollection
Результат Prado\Collections\TAttributeCollection the list of custom attributes

getCausesValidation() публичный Метод

public getCausesValidation ( ) : boolean
Результат boolean whether postback event trigger by this hotspot will cause input validation, default is true

getCoordinates() абстрактный публичный Метод

abstract public getCoordinates ( ) : string
Результат string coordinates defining the hotspot shape.

getHasAttributes() публичный Метод

public getHasAttributes ( ) : boolean
Результат boolean whether the hotspot has custom attributes

getHotSpotMode() публичный Метод

public getHotSpotMode ( ) : THotSpotMode
Результат THotSpotMode the behavior of a HotSpot object when it is clicked. Defaults to THotSpotMode::NotSet.

getNavigateUrl() публичный Метод

public getNavigateUrl ( ) : string
Результат string the URL to navigate to when a HotSpot object is clicked. Defaults to ''.

getPostBackValue() публичный Метод

public getPostBackValue ( ) : string
Результат string a value that is post back when the HotSpot is clicked. Defaults to ''.

getShape() абстрактный публичный Метод

abstract public getShape ( ) : string
Результат string shape of the hotspot, can be 'circle', 'rect', 'poly', etc.

getTabIndex() публичный Метод

public getTabIndex ( ) : integer
Результат integer the tab index of the HotSpot region. Defaults to 0.

getTarget() публичный Метод

public getTarget ( ) : string
Результат string the target window or frame to display the new page when the HotSpot region is clicked. Defaults to ''.

getValidationGroup() публичный Метод

public getValidationGroup ( ) : string
Результат string the group of validators which the hotspot causes validation upon postback

getViewState() защищенный Метод

This function is very useful in defining getter functions for component properties that must be kept in viewstate.
protected getViewState ( $key, $defaultValue = null ) : mixed
Результат mixed the viewstate value corresponding to $key

hasAttribute() публичный Метод

public hasAttribute ( $name ) : boolean
Результат boolean whether the named attribute exists

removeAttribute() публичный Метод

Removes the named attribute.
public removeAttribute ( $name ) : string
Результат string attribute value removed, null if attribute does not exist.

render() публичный Метод

Renders this hotspot.
public render ( $writer )

setAccessKey() публичный Метод

public setAccessKey ( $value )

setAlternateText() публичный Метод

public setAlternateText ( $value )

setAttribute() публичный Метод

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

setCausesValidation() публичный Метод

public setCausesValidation ( $value )

setHotSpotMode() публичный Метод

public setHotSpotMode ( $value )

setNavigateUrl() публичный Метод

public setNavigateUrl ( $value )

setPostBackValue() публичный Метод

public setPostBackValue ( $value )

setTabIndex() публичный Метод

public setTabIndex ( $value )

setTarget() публичный Метод

public setTarget ( $value )

setValidationGroup() публичный Метод

public setValidationGroup ( $value )

setViewState() защищенный Метод

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 )