PRADO Component Framework for PHP 5
  • Home
  • About
  • Testimonials
  • Demos
  • Download
  • Documentation
  • Forum
  • Development
  • Tutorials
  • Class Docs
  • API Manual
  • Wiki

Packages

  • None
  • System
    • Caching
    • Collections
    • Data
      • ActiveRecord
        • Relations
        • Scaffold
          • InputBuilder
      • Commom
        • Sqlite
      • Common
        • Mssql
        • Mysql
        • Oracle
        • Pgsql
        • Sqlite
      • DataGateway
      • SqlMap
        • Configuration
        • Statements
    • Exceptions
    • I18N
    • IO
    • Security
    • Util
    • Web
      • Javascripts
      • Services
      • UI
        • ActiveControls
        • WebControls
    • Xml
  • Wsat
    • pages
  • Overview
  • Package
  • Class
  • Tree
  • Deprecated
  • Todo

Class THotSpot

THotSpot class.

THotSpot implements the basic functionality common to all hot spot shapes. Derived classes include TCircleHotSpot, TPolygonHotSpot and TRectangleHotSpot.

TComponent
Extended by THotSpot

Direct known subclasses

TCircleHotSpot, TPolygonHotSpot, TRectangleHotSpot
Abstract
Package: System\Web\UI\WebControls
Copyright: Copyright © 2005-2014 PradoSoft
License: http://www.pradosoft.com/license/
Author: Qiang Xue <qiang.xue@gmail.com>
Since: 3.0
Located at Web/UI/WebControls/TImageMap.php
Methods summary
protected mixed
# getViewState( string $key, mixed $defaultValue = null )

Returns a viewstate value.

Returns a viewstate value.

This function is very useful in defining getter functions for component properties that must be kept in viewstate.

Parameters

$key
string
the name of the viewstate value to be returned
$defaultValue
mixed
the default value. If $key is not found in viewstate, $defaultValue will be returned

Returns

mixed
the viewstate value corresponding to $key
protected
# setViewState( string $key, mixed $value, mixed $defaultValue = null )

Sets a viewstate value.

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.

Parameters

$key
string
the name of the viewstate value
$value
mixed
the viewstate value to be set
$defaultValue
mixed
default value. If $value===$defaultValue, the item will be cleared from the viewstate.
abstract public string
# getShape( )

Returns

string
shape of the hotspot, can be 'circle', 'rect', 'poly', etc.
abstract public string
# getCoordinates( )

Returns

string
coordinates defining the hotspot shape.
public string
# getAccessKey( )

Returns

string
the access key that allows you to quickly navigate to the HotSpot region. Defaults to ''.
public
# setAccessKey( string $value )

Parameters

$value
string
the access key that allows you to quickly navigate to the HotSpot region.
public string
# getAlternateText( )

Returns

string
the alternate text to display for a HotSpot object. Defaults to ''.
public
# setAlternateText( string $value )

Parameters

$value
string
the alternate text to display for a HotSpot object.
public THotSpotMode
# getHotSpotMode( )

Returns

THotSpotMode
the behavior of a HotSpot object when it is clicked. Defaults to THotSpotMode::NotSet.
public
# setHotSpotMode( THotSpotMode $value )

Parameters

$value
THotSpotMode
the behavior of a HotSpot object when it is clicked.
public string
# getNavigateUrl( )

Returns

string
the URL to navigate to when a HotSpot object is clicked. Defaults to ''.
public
# setNavigateUrl( string $value )

Parameters

$value
string
the URL to navigate to when a HotSpot object is clicked.
public string
# getPostBackValue( )

Returns

string
a value that is post back when the HotSpot is clicked. Defaults to ''.
public
# setPostBackValue( string $value )

Parameters

$value
string
a value that is post back when the HotSpot is clicked.
public integer
# getTabIndex( )

Returns

integer
the tab index of the HotSpot region. Defaults to 0.
public
# setTabIndex( integer $value )

Parameters

$value
integer
the tab index of the HotSpot region.
public boolean
# getCausesValidation( )

Returns

boolean
whether postback event trigger by this hotspot will cause input validation, default is true
public
# setCausesValidation( boolean $value )

Parameters

$value
boolean
whether postback event trigger by this hotspot will cause input validation
public string
# getValidationGroup( )

Returns

string
the group of validators which the hotspot causes validation upon postback
public
# setValidationGroup( string $value )

Parameters

$value
string
the group of validators which the hotspot causes validation upon postback
public string
# getTarget( )

Returns

string
the target window or frame to display the new page when the HotSpot region is clicked. Defaults to ''.
public
# setTarget( string $value )

Parameters

$value
string
the target window or frame to display the new page when the HotSpot region is clicked.
public boolean
# getHasAttributes( )

Returns

boolean
whether the hotspot has custom attributes
public TAttributeCollection
# getAttributes( )

Returns the list of custom attributes. Custom attributes are name-value pairs that may be rendered as HTML tags' attributes.

Returns the list of custom attributes. Custom attributes are name-value pairs that may be rendered as HTML tags' attributes.

Returns

TAttributeCollection
the list of custom attributes
public boolean
# hasAttribute( mixed $name )

Returns

boolean
whether the named attribute exists
public string
# getAttribute( mixed $name )

Returns

string
attribute value, null if attribute does not exist
public
# setAttribute( string $name, string $value )

Sets a custom hotspot attribute.

Sets a custom hotspot attribute.

Parameters

$name
string
attribute name
$value
string
value of the attribute
public string
# removeAttribute( string $name )

Removes the named attribute.

Removes the named attribute.

Parameters

$name
string
the name of the attribute to be removed.

Returns

string
attribute value removed, null if attribute does not exist.
public
# render( THtmlWriter $writer )

Renders this hotspot.

Renders this hotspot.

Parameters

$writer
THtmlWriter
Methods inherited from TComponent
__call(), __construct(), __destruct(), __get(), __isset(), __set(), __sleep(), __unset(), __wakeup(), addParsedObject(), 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 TComponent
GLOBAL_RAISE_EVENT_LISTENER
Terms of Service | Contact Us
PRADO v3.2.4 API Manual API documentation generated by ApiGen 2.8.0
Copyright © 2006-2014 by the PRADO Group.
Powered by PRADO