HtmlBasedComponent"
From Documentation
Jumperchen (talk | contribs) |
|||
| (5 intermediate revisions by 2 users not shown) | |||
| Line 10: | Line 10: | ||
A skeletal implementation for HTML based components. It simplifies to implement methods common to HTML based components. | A skeletal implementation for HTML based components. It simplifies to implement methods common to HTML based components. | ||
| − | |||
| − | + | =Supported Events= | |
| − | + | {| class='wikitable' | width="100%" | |
| − | |||
| − | {| | ||
! <center>Name</center> | ! <center>Name</center> | ||
! <center>Event Type</center> | ! <center>Event Type</center> | ||
|- | |- | ||
| − | | <center>< | + | | <center><code>onDrop</code></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 | + | Denotes a user has dropped the dragged target to a component. |
|- | |- | ||
| − | | <center>< | + | | <center><code>onClick</code></center> |
| '''Event:''' <javadoc> org.zkoss.zk.ui.event.MouseEvent</javadoc> | | '''Event:''' <javadoc> org.zkoss.zk.ui.event.MouseEvent</javadoc> | ||
| − | Denotes user has clicked | + | Denotes a user has clicked a component. |
|- | |- | ||
| − | | <center>< | + | | <center><code>onDoubleClick</code></center> |
| '''Event:''' <javadoc> org.zkoss.zk.ui.event.MouseEvent</javadoc> | | '''Event:''' <javadoc> org.zkoss.zk.ui.event.MouseEvent</javadoc> | ||
| − | Denotes user has double-clicked | + | Denotes a user has double-clicked a component. |
|- | |- | ||
| − | | <center>< | + | | <center><code>onRightClick</code></center> |
| '''Event:''' <javadoc> org.zkoss.zk.ui.event.MouseEvent</javadoc> | | '''Event:''' <javadoc> org.zkoss.zk.ui.event.MouseEvent</javadoc> | ||
| − | Denotes user has right-clicked | + | Denotes a user has right-clicked a component. |
|- | |- | ||
| − | | <center>< | + | | <center><code>onMouseOver</code></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. | + | {{versionSince| 5.0.3}} Denotes a user has hovered over the component. |
|- | |- | ||
| − | | <center>< | + | | <center><code>onMouseOut</code></center> |
| '''Event:''' <javadoc> org.zkoss.zk.ui.event.MoveEvent</javadoc> | | '''Event:''' <javadoc> org.zkoss.zk.ui.event.MoveEvent</javadoc> | ||
| − | Denotes user has moved out | + | {{versionSince| 5.0.3}} Denotes a user has moved out a component. |
|- | |- | ||
| − | | <center>< | + | | <center><code>onOK </code></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 a user has pressed the '''ENTER''' key. |
|- | |- | ||
| − | | <center>< | + | | <center><code>onCancel </code></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 a user has pressed the '''ESC''' key. |
|- | |- | ||
| − | | <center>< | + | | <center><code>onCtrlKey</code></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 a user has pressed a special key, such as PgUp, Home, and a key combined with the Ctrl or Alt key. Refer to the <code>ctrlKeys</code> Property section below for details. |
| + | |- | ||
| + | | <center><code>onAfterSize</code></center> | ||
| + | | '''Event:''' <javadoc>org.zkoss.zk.ui.event.AfterSizeEvent</javadoc> | ||
| + | It's fired after | ||
| + | * a user resizes a sizable component in a browser | ||
| + | * a component calculates its size in a browser | ||
| + | |- | ||
| + | | <center><code>onCreate</code></center> | ||
| + | | '''Event:''' <javadoc>org.zkoss.zk.ui.event.CreateEvent</javadoc> | ||
|} | |} | ||
| Line 67: | Line 73: | ||
*ALL | *ALL | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
=Version History= | =Version History= | ||
| − | {| | + | {| class='wikitable' | width="100%" |
! Version !! Date !! Content | ! Version !! Date !! Content | ||
|- | |- | ||
Latest revision as of 02:48, 10 June 2022
Html Based Component
- Demonstration: N/A
- Java API: HtmlBasedComponent
- JavaScript API: Widget
Employment/Purpose
A skeletal implementation for HTML based components. It simplifies to implement methods common to HTML based components.
Supported Events
onDrop |
Event: DropEvent
Denotes a user has dropped the dragged target to a component. |
onClick |
Event: MouseEvent
Denotes a user has clicked a component. |
onDoubleClick |
Event: MouseEvent
Denotes a user has double-clicked a component. |
onRightClick |
Event: MouseEvent
Denotes a user has right-clicked a component. |
onMouseOver |
Event: MoveEvent
Since 5.0.3 Denotes a user has hovered over the component. |
onMouseOut |
Event: MoveEvent
Since 5.0.3 Denotes a user has moved out a component. |
onOK |
Event: KeyEvent
Denotes a user has pressed the ENTER key. |
onCancel |
Event: KeyEvent
Denotes a user has pressed the ESC key. |
onCtrlKey |
Event: KeyEvent
Denotes a user has pressed a special key, such as PgUp, Home, and a key combined with the Ctrl or Alt key. Refer to the |
onAfterSize |
Event: AfterSizeEvent
It's fired after
|
onCreate |
Event: CreateEvent |
Supported Children
*ALL
Version History
| Version | Date | Content |
|---|---|---|
| 5.0.3 | June 2010 | The onMouseOver and onMouseOut events are supported. |