|
Class TImageMap
TImageMap class
TImageMap represents an image on a page. Hotspot regions can be defined
within the image. Depending on the setHotSpotMode HotSpotMode, clicking
on the hotspots may trigger a postback or navigate to a specified URL. The
hotspots defined may be accessed via getHotSpots HotSpots. Each hotspot
is described as a THotSpot , which can be a circle, rectangle, polygon,
etc. To add hotspot in a template, use the following,
<com:TImageMap>
<com:TCircleHotSpot ... />
<com:TRectangleHotSpot ... />
<com:TPolygonHotSpot ... />
</com:TImageMap>
-
TComponent
-
TApplicationComponent
-
TControl
implements
IRenderable,
IBindable
-
TWebControl
implements
IStyleable
-
TImage
implements
IDataRenderer
-
TImageMap
implements
IPostBackEventHandler
Methods summary
public
|
#
addParsedObject( string|TComponent $object )
Processes an object that is created during parsing template. This method adds
THotSpot objects into the hotspot collection of the imagemap.
Processes an object that is created during parsing template. This method adds
THotSpot objects into the hotspot collection of the imagemap.
Parameters
- $object
string|TComponent text string or component parsed and instantiated in template
Overrides
|
protected
|
#
addAttributesToRender( THtmlWriter $writer )
Adds attribute name-value pairs to renderer. This overrides the parent
implementation with additional imagemap specific attributes.
Adds attribute name-value pairs to renderer. This overrides the parent
implementation with additional imagemap specific attributes.
Parameters
- $writer
THtmlWriter
the writer used for the rendering purpose
Overrides
|
public
|
#
render( THtmlWriter $writer )
Renders this imagemap.
Parameters
Overrides
|
protected
string
|
#
getClientClassName( )
Gets the name of the javascript class responsible for performing postback for
this control. This method overrides the parent implementation.
Gets the name of the javascript class responsible for performing postback for
this control. This method overrides the parent implementation.
Returns
string the javascript class name
|
public
|
#
raisePostBackEvent( TEventParameter $param )
Raises the postback event. This method is required by IPostBackEventHandler interface. This method is mainly used by framework and
control developers.
Raises the postback event. This method is required by IPostBackEventHandler interface. This method is mainly used by framework and
control developers.
Parameters
Implementation of
|
public
THotSpotMode
|
#
getHotSpotMode( )
Returns
THotSpotMode
the behavior of hotspot regions in this imagemap when they are clicked. Defaults
to THotSpotMode::NotSet.
|
public
|
#
setHotSpotMode( THotSpotMode $value )
Sets the behavior of hotspot regions in this imagemap when they are clicked.
If an individual hotspot has a mode other than 'NotSet', the mode set in this
imagemap will be ignored. By default, 'NotSet' is equivalent to 'Navigate'.
Sets the behavior of hotspot regions in this imagemap when they are clicked.
If an individual hotspot has a mode other than 'NotSet', the mode set in this
imagemap will be ignored. By default, 'NotSet' is equivalent to 'Navigate'.
Parameters
- $value
THotSpotMode
the behavior of hotspot regions in this imagemap when they are clicked.
|
public
THotSpotCollection
|
|
public
string
|
#
getTarget( )
Returns
string the target window or frame to display the new page when a hotspot region is
clicked within the imagemap. Defaults to ''.
|
public
|
#
setTarget( string $value )
Parameters
- $value
string the target window or frame to display the new page when a hotspot region is
clicked within the imagemap.
|
public
|
#
onClick( TImageMapEventParameter $param )
Raises OnClick event. This method is invoked when a hotspot region is
clicked within the imagemap. If you override this method, be sure to call the
parent implementation so that the event handler can be invoked.
Raises OnClick event. This method is invoked when a hotspot region is
clicked within the imagemap. If you override this method, be sure to call the
parent implementation so that the event handler can be invoked.
Parameters
|
Methods inherited from TImage
getAlternateText(),
getData(),
getDescriptionUrl(),
getImageAlign(),
getImageUrl(),
getTagName(),
renderContents(),
setAlternateText(),
setData(),
setDescriptionUrl(),
setImageAlign(),
setImageUrl()
|
Methods inherited from TWebControl
clearStyle(),
copyBaseAttributes(),
createStyle(),
getAccessKey(),
getBackColor(),
getBorderColor(),
getBorderStyle(),
getBorderWidth(),
getCssClass(),
getDecorator(),
getDisplay(),
getEnsureId(),
getFont(),
getForeColor(),
getHasStyle(),
getHeight(),
getStyle(),
getTabIndex(),
getToolTip(),
getWidth(),
onPreRender(),
renderBeginTag(),
renderEndTag(),
setAccessKey(),
setBackColor(),
setBorderColor(),
setBorderStyle(),
setBorderWidth(),
setCssClass(),
setDisplay(),
setEnsureId(),
setForeColor(),
setHeight(),
setStyle(),
setTabIndex(),
setToolTip(),
setWidth()
|
Methods inherited from TControl
__construct(),
__get(),
addToPostDataLoader(),
addedControl(),
applyStyleSheetSkin(),
autoBindProperty(),
autoDataBindProperties(),
bindProperty(),
broadcastEvent(),
bubbleEvent(),
clearChildState(),
clearControlState(),
clearNamingContainer(),
clearViewState(),
convertUniqueIdToClientId(),
createChildControls(),
createControlCollection(),
dataBind(),
dataBindChildren(),
dataBindProperties(),
ensureChildControls(),
findControl(),
findControlsByID(),
findControlsByType(),
focus(),
getAdapter(),
getAllowChildControls(),
getAttribute(),
getAttributes(),
getChildControlsCreated(),
getClientID(),
getControlStage(),
getControlState(),
getControls(),
getCustomData(),
getEnableTheming(),
getEnableViewState(),
getEnabled(),
getHasAdapter(),
getHasAttributes(),
getHasChildInitialized(),
getHasControls(),
getHasInitialized(),
getHasLoaded(),
getHasLoadedPostData(),
getHasPreRendered(),
getID(),
getIsSkinApplied(),
getNamingContainer(),
getPage(),
getParent(),
getRegisteredObject(),
getSkinID(),
getSourceTemplateControl(),
getTemplateControl(),
getUniqueID(),
getViewState(),
getVisible(),
hasAttribute(),
initRecursive(),
isDescendentOf(),
isObjectRegistered(),
loadRecursive(),
loadState(),
loadStateRecursive(),
onDataBinding(),
onInit(),
onLoad(),
onUnload(),
preRenderRecursive(),
raiseBubbleEvent(),
registerObject(),
removeAttribute(),
removedControl(),
renderChildren(),
renderControl(),
saveState(),
saveStateRecursive(),
setAdapter(),
setAttribute(),
setChildControlsCreated(),
setControlStage(),
setControlState(),
setCustomData(),
setEnableTheming(),
setEnableViewState(),
setEnabled(),
setID(),
setPage(),
setSkinID(),
setTemplateControl(),
setViewState(),
setVisible(),
trackViewState(),
traverseChildControls(),
unbindProperty(),
unloadRecursive(),
unregisterObject()
|
Methods inherited from TComponent
__call(),
__destruct(),
__isset(),
__set(),
__sleep(),
__unset(),
__wakeup(),
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 summary
string |
MAP_NAME_PREFIX |
'ImageMap' |
|
Constants inherited from TControl
AUTOMATIC_ID_PREFIX,
CLIENT_ID_SEPARATOR,
CS_CHILD_INITIALIZED,
CS_CONSTRUCTED,
CS_INITIALIZED,
CS_LOADED,
CS_PRERENDERED,
CS_STATE_LOADED,
ID_FORMAT,
ID_SEPARATOR,
IS_CHILD_CREATED,
IS_CREATING_CHILD,
IS_DISABLE_THEMING,
IS_DISABLE_VIEWSTATE,
IS_ID_SET,
IS_SKIN_APPLIED,
IS_STYLESHEET_APPLIED,
RF_ADAPTER,
RF_AUTO_BINDINGS,
RF_CHILD_STATE,
RF_CONTROLS,
RF_CONTROLSTATE,
RF_DATA_BINDINGS,
RF_EVENTS,
RF_NAMED_CONTROLS,
RF_NAMED_CONTROLS_ID,
RF_NAMED_OBJECTS,
RF_SKIN_ID
|
|