HtmlBasedComponent"

From Documentation
(One intermediate revision by the same user not shown)
Line 14: Line 14:
 
N/A
 
N/A
  
=Supported events=
+
=Supported Events=
  
 
{| border="1" | width="100%"
 
{| border="1" | width="100%"
Line 21: Line 21:
 
|-
 
|-
 
| <center><tt>onDrop</tt></center>
 
| <center><tt>onDrop</tt></center>
| '''Event:'''<javadoc>org.zkoss.zk.ui.event.DropEvent</javadoc>
+
| '''Event:''' <javadoc>org.zkoss.zk.ui.event.DropEvent</javadoc>
 
Denotes user has dropped the dragged target to the component.
 
Denotes user has dropped the dragged target to the component.
 
|-
 
|-
 
| <center><tt>onClick</tt></center>
 
| <center><tt>onClick</tt></center>
| '''Event:'''<javadoc> org.zkoss.zk.ui.event.MouseEvent</javadoc>
+
| '''Event:''' <javadoc> org.zkoss.zk.ui.event.MouseEvent</javadoc>
  
 
Denotes user has clicked the component.  
 
Denotes user has clicked the component.  
 
|-
 
|-
 
| <center><tt>onDoubleClick</tt></center>
 
| <center><tt>onDoubleClick</tt></center>
| '''Event:'''<javadoc> org.zkoss.zk.ui.event.MouseEvent</javadoc>
+
| '''Event:''' <javadoc> org.zkoss.zk.ui.event.MouseEvent</javadoc>
 
Denotes user has double-clicked the component.
 
Denotes user has double-clicked the component.
 
|-
 
|-
 
| <center><tt>onRightClick</tt></center>
 
| <center><tt>onRightClick</tt></center>
| '''Event:'''<javadoc> org.zkoss.zk.ui.event.MouseEvent</javadoc>
+
| '''Event:''' <javadoc> org.zkoss.zk.ui.event.MouseEvent</javadoc>
 
Denotes user has right-clicked the component.
 
Denotes user has right-clicked the component.
 
|-
 
|-
 
| <center><tt>onMouseOver</tt></center>
 
| <center><tt>onMouseOver</tt></center>
| '''Event:'''<javadoc> org.zkoss.zk.ui.event.MoveEvent</javadoc>
+
| '''Event:''' <javadoc> org.zkoss.zk.ui.event.MoveEvent</javadoc>
 
Denotes user has hovered over the component.
 
Denotes user has hovered over the component.
 
|-
 
|-
 
| <center><tt>onMouseOut</tt></center>
 
| <center><tt>onMouseOut</tt></center>
| '''Event:'''<javadoc> org.zkoss.zk.ui.event.MoveEvent</javadoc>
+
| '''Event:''' <javadoc> org.zkoss.zk.ui.event.MoveEvent</javadoc>
 
Denotes user has moved out the component.
 
Denotes user has moved out the component.
 
|-
 
|-
 
| <center><tt>onOK </tt></center>
 
| <center><tt>onOK </tt></center>
| '''Event:'''<javadoc>org.zkoss.zk.ui.event.KeyEvent</javadoc>
+
| '''Event:''' <javadoc>org.zkoss.zk.ui.event.KeyEvent</javadoc>
  
 
Denotes user has pressed the ENTER key.
 
Denotes user has pressed the ENTER key.
Line 52: Line 52:
 
|-
 
|-
 
| <center><tt>onCancel </tt></center>
 
| <center><tt>onCancel </tt></center>
| '''Event:'''<javadoc>org.zkoss.zk.ui.event.KeyEvent</javadoc>
+
| '''Event:''' <javadoc>org.zkoss.zk.ui.event.KeyEvent</javadoc>
  
 
Denotes user has pressed the ESC key.
 
Denotes user has pressed the ESC key.
Line 58: Line 58:
 
|-
 
|-
 
| <center><tt>onCtrlKey</tt></center>
 
| <center><tt>onCtrlKey</tt></center>
| '''Event: '''<javadoc>org.zkoss.zk.ui.event.KeyEvent</javadoc>
+
| '''Event:''' <javadoc>org.zkoss.zk.ui.event.KeyEvent</javadoc>
  
 
Denotes user has pressed a special key, such as PgUp, Home and a key combined with the Ctrl or Alt key. Refer to the ctrlKeys Property section below for details.
 
Denotes user has pressed a special key, such as PgUp, Home and a key combined with the Ctrl or Alt key. Refer to the ctrlKeys Property section below for details.

Revision as of 10:04, 11 November 2010


HtmlBasedComponent

Html Based Component

Employment/Purpose

A skeletal implementation for HTML based components. It simplifies to implement methods common to HTML based components.

Example

N/A

Supported Events

Name
Event Type
onDrop
Event: DropEvent

Denotes user has dropped the dragged target to the component.

onClick
Event: MouseEvent

Denotes user has clicked the component.

onDoubleClick
Event: MouseEvent

Denotes user has double-clicked the component.

onRightClick
Event: MouseEvent

Denotes user has right-clicked the component.

onMouseOver
Event: MoveEvent

Denotes user has hovered over the component.

onMouseOut
Event: MoveEvent

Denotes user has moved out the component.

onOK
Event: KeyEvent

Denotes user has pressed the ENTER key.

onCancel
Event: KeyEvent

Denotes user has pressed the ESC key.

onCtrlKey
Event: KeyEvent

Denotes user has pressed a special key, such as PgUp, Home and a key combined with the Ctrl or Alt key. Refer to the ctrlKeys Property section below for details.

Supported Children

*ALL

Use cases

Version Description Example Location
     

Version History

Version Date Content
5.0.3 June 2010 The onMouseOver and onMouseOut events are supported.



Last Update : 2010/11/11

Copyright © Potix Corporation. This article is licensed under GNU Free Documentation License.