Home | Class Index

SDK Version: 3.11.4-302512

Documentation generated on 24 July 2015

Class
caplin.control.basic

ImageControl

Extends caplin.control.basic.BasicControl.

This is a basic control that is used to display an image and capture user gestures (when an appropriate handler is configured). Typically, the ImageControl uses stylers (e.g. caplin.element.styler.ClassStyler) to specify how the image appears to the user, and handlers to capture user interactions such as mouse movements and clicks.

The image control configuration is set in rendererDefinitions.xml.

Basic usage:

  <control type="caplin.control.basic.ImageControl"/>

With this configuration, a default template is assigned: 

	<div><div></div></div>

To specify a custom template:

  <control type="caplin.control.basic.ImageControl">
    <![CDATA[<div><div></div></div>]]>
  </control>

Optionally, a handler (e.g. caplin.element.handler.grid.ClearFilterHandler) can be configured against the control

  <control type="caplin.control.basic.ImageControl">
    <handler className="caplin.element.handler.grid.ClearFilterHandler"/>
  </control>

Constructor Summary

Attributes Name and Description
caplin.control.basic.ImageControl(caplin.control.factory.ControlType controlType)

Constructs a new caplin.control.basic.ImageControl with the specified arguments.

Method Summary

Attributes Name and Description
void createHtml( value, initialClassName)

void disable()

void enable()

void isEnabled()

void setDomValue()

void toString()

Methods inherited from class caplin.control.basic.BasicControl:
addClass, attachControlEventListener, bind, clear, clearState, detachControlEventListener, finalize, flash, focus, getAttributes, getElement, getFlashDuration, getId, getInitialClassName, getNumericFlashDirection, getValue, initialize, isBound, refresh, removeClass, removeFlash, replaceClass, select, setAttribute, setDomAttribute, setDomClass, setDomParentClass, setDomStyle, setId, setInitialClassName, setStyle, setTooltip, setValue, unbind

Constructor Detail

► caplin.control.basic.ImageControl(caplin.control.factory.ControlType controlType)

Constructs a new caplin.control.basic.ImageControl with the specified arguments.

Parameters
caplin.control.factory.ControlType controlType The control type.

Method Detail

► void createHtml( value, initialClassName)

Parameters
value
initialClassName
See
caplin.control.factory.ControlFramework#createHtml

► void disable()

See
caplin.control.Control#disable

► void enable()

See
caplin.control.Control#enable

► void isEnabled()

See
caplin.control.Control#isEnabled

► void toString()

See
caplin.control.Control#toString