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
파일 보기 프로젝트 열기: pradosoft/prado

공개 메소드들

메소드 설명
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 )