Popup"

From Documentation
 
(30 intermediate revisions by 10 users not shown)
Line 3: Line 3:
 
= Popup  =
 
= Popup  =
  
−
*Demonstration: [http://www.zkoss.org/zkdemo/userguide/#t5 Tooltips and Popup]  
+
*Demonstration: [http://www.zkoss.org/zkdemo/popup Tooltips and Popup]  
 
*Java API: <javadoc>org.zkoss.zul.Popup</javadoc>
 
*Java API: <javadoc>org.zkoss.zul.Popup</javadoc>
 
*JavaScript API: <javadoc directory="jsdoc">zul.wgt.Popup</javadoc>
 
*JavaScript API: <javadoc directory="jsdoc">zul.wgt.Popup</javadoc>
 +
*Style Guide: [[ZK_Style_Guide/XUL_Component_Specification/Popup | Popup]]
  
 
= Employment/Purpose =
 
= Employment/Purpose =
  
−
A container that is displayed as a popup. The popup window does not have any special frame. Popups can be displayed when an element is clicked by assigning the id of the popup to either the XulElement.setPopup(java.lang.String), XulElement.setContext(java.lang.String) or XulElement.setTooltip(java.lang.String) attribute of the element.
+
The popup is a container that does not have any special frame. You can associate a popup with any component by specifying the popup's id at one of the following attributes:
  
 +
<source lang='xml'>
 +
    <button popup="popup_id"/>
 +
    <button tooltip="popup_id"/>
 +
    <button context="popup_id"/>
 +
 +
    <popup id="popup_id">
 +
        this is a popup
 +
    </popup>
 +
</source>
  
 
= Example =
 
= Example =
  
−
[[Image:Popup.png]]
+
[[Image:ZKComRef_Popup.PNG]]
  
−
<source lang="xml" >
+
<source lang="xml">
−
<label value="Move Mouse Over Me!" tooltip="editPopup" />
 
 
<separator bar="true" />
 
<separator bar="true" />
 
<label value="Tooptip for Another Popup" tooltip="any" />
 
<label value="Tooptip for Another Popup" tooltip="any" />
−
<separator bar="true" />
 
−
...
 
 
<popup id="any" width="300px">
 
<popup id="any" width="300px">
 
<vbox>
 
<vbox>
Line 29: Line 36:
 
</vbox>
 
</vbox>
 
</popup>
 
</popup>
 +
</source>
 +
[[Image:ZKComRef_Popup2.PNG]]
 +
<source lang="xml">
 +
<textbox popup="popup, position=after_start"/>
 +
<popup id="popup" width="300px">
 +
<vbox>
 +
ZK simply rich.
 +
<toolbarbutton label="ZK your killer Web application now!"
 +
href="http://www.zkoss.org" />
 +
</vbox>
 +
</popup>
 +
</source>
 +
 +
=Position=
 +
You can simply specify a popup's position when attaching to a component by
 +
 +
* built-in position
 +
* x, y coordinate
 +
 +
<source lang="XML">
 +
<button popup="popup_id, position=overlap_end"/>
 +
<button popup="popup_id, x=50,y=50"/>
 +
</source>
 +
 +
 +
{{versionSince| 6.0.1}}
 +
ZK supports the following position string:
 +
 +
[[Image:ZKComRef_Popup_Position_601.png]]
 +
 +
overlap, overlap_end, overlap_before, overlap_after are kept (still available) for backward compatibility. They are identical with top_left, top_right, bottom_left, and bottom_right, respectively.
 +
 +
Before 6.0.0
 +
The 14 possible positions are provided below:
 +
 +
[[Image:ZKComRef_Popup_Position.png | center]]
 +
 +
The following illustrates the simplicity of usage,
 +
 +
<source lang="xml" highlight="4">
 +
<popup id="pp">
 +
Here is popup
 +
</popup>
 +
<button label="before_start" onClick='pp.open(self, "before_start");' />
 +
</source>
 +
 +
Upon clicking the button the popup component will appear in the relative position specified. In this case the position is just above the button.
 +
 +
[[Image:ZKComRef_Popup_Beforestart.png]]
 +
 +
 +
 +
== Methods ==
 +
There are several overloading open() methods available, please check [https://www.zkoss.org/javadoc/latest/zk/org/zkoss/zul/Popup.html javadoc]
 +
 +
= Toggle Popup =
 +
 +
{{versionSince| 7.0.0}}
 +
If a popup/context menu is assigned to a target component via the popup/context attribute, the popup will show up when the user clicks on the target component. Click the target component again, the popup will still show up by default. As of 7.0.0, The popup/context attribute supports an additional toggle type, which could make the target component act as a toggle switcher. If the popup has not shown up yet, clicking the target component will cause the popup to show up. If the popup is showing up, clicking on the target component again will toggle the popup to hide. The usage is in the below code.
 +
 +
<source lang="xml">
 +
<button label="Popup" popup="id, type=toggle"/>
 
</source>
 
</source>
  
 +
= Tooltip Delay=
  
 +
The tooltip attribute can also support a delay, the following code outlines how to accomplish this.
 +
 +
<source lang="xml">
 +
<label value="Tooltip" tooltip="popup_id, position=before_start, delay=500"/>
 +
</source>
  
−
=Supported events=
+
=Supported Events=
  
−
{| border="1" | width="100%"
+
{| class='wikitable' | width="100%"
 
! <center>Name</center>
 
! <center>Name</center>
 
! <center>Event Type</center>
 
! <center>Event Type</center>
 
|-
 
|-
−
| None
+
|-
−
| None
+
| <center><code>onOpen</code></center>
 +
| '''Event:''' <javadoc>org.zkoss.zk.ui.event.OpenEvent</javadoc>
 +
Denotes a Popup has been opened or '''closed''' (in this case OpenEvent::isOpen() returns false).
 
|}
 
|}
 +
*Inherited Supported Events: [[ZK_Component_Reference/Base_Components/XulElement#Supported_Events | XulElement]]
  
 
=Supported Children=
 
=Supported Children=
Line 47: Line 125:
 
  *ALL
 
  *ALL
  
−
=Use cases=
+
=Use Cases=
  
−
{| border='1px' | width="100%"
+
{| class='wikitable' | width="100%"
 
! Version !! Description !! Example Location
 
! Version !! Description !! Example Location
 
|-
 
|-
 
| 3.6
 
| 3.6
 
| Smalltalk: Toolbar and Menus
 
| Smalltalk: Toolbar and Menus
−
| [http://docs.zkoss.org/wiki/Toolbar_and_Menus#Customizable_Tooltip_and_Popup_Menus http://docs.zkoss.org/wiki/Toolbar_and_Menus#Customizable_Tooltip_and_Popup_Menus]
+
| [[ZK Developer's Reference/UI Patterns/Tooltips, Context Menus and Popups|ZK Developer's Reference: Tooltips, Context Menus and Popups]]
 
|-
 
|-
 
| 3.6
 
| 3.6
 
| A way to specify the position of the Popup component
 
| A way to specify the position of the Popup component
−
| [http://docs.zkoss.org/wiki/New_Features_of_ZK_3.6.1#A_way_to_specify_the_position_of_the_Popup_component http://docs.zkoss.org/wiki/New_Features_of_ZK_3.6.1#A_way_to_specify_the_position_of_the_Popup_component]
+
| [[Small_Talks/2009/April/New_Features_of_ZK_3.6.1#A_way_to_specify_the_position_of_the_Popup_component A way to specify the position of the Popup component|New Features of ZK 3.6.1]]
 
|-
 
|-
 
| 3.6
 
| 3.6
 
| Popup, tooltip and context positions
 
| Popup, tooltip and context positions
−
| [http://docs.zkoss.org/wiki/New_Features_of_ZK_3.6.3#Popup.2C_tooltip_and_context_positions http://docs.zkoss.org/wiki/New_Features_of_ZK_3.6.3#Popup.2C_tooltip_and_context_positions]
+
| [[Small_Talks/2009/November/New_Features_of_ZK_3.6.3#Popup.2C_tooltip_and_context_positions Popup, tooltip and context positions|New Features of ZK 3.6.3]]
 
|}
 
|}
  
 
=Version History=
 
=Version History=
−
 
+
{{LastUpdated}}
−
{| border='1px' | width="100%"
+
{| class='wikitable' | width="100%"
 
! Version !! Date !! Content
 
! Version !! Date !! Content
 
|-
 
|-
−
| &nbsp;
+
| 7.0.0
−
| &nbsp;
+
| Nov 2013
−
| &nbsp;
+
| Popup support toggle type
 
|}
 
|}
  
 
{{ZKComponentReferencePageFooter}}
 
{{ZKComponentReferencePageFooter}}

Latest revision as of 05:57, 15 January 2024


DocumentationZK Component ReferenceEssential ComponentsPopup
Popup

Popup

Employment/Purpose

The popup is a container that does not have any special frame. You can associate a popup with any component by specifying the popup's id at one of the following attributes: 

    <button popup="popup_id"/>
    <button tooltip="popup_id"/>
    <button context="popup_id"/>

    <popup id="popup_id">
        this is a popup
    </popup>

Example

ZKComRef Popup.PNG 

<separator bar="true" />
<label value="Tooptip for Another Popup" tooltip="any" />
<popup id="any" width="300px">
	<vbox>
		ZK simply rich.
		<toolbarbutton label="ZK your killer Web application now!"
			href="http://www.zkoss.org" />
	</vbox>
</popup>

ZKComRef Popup2.PNG 

<textbox popup="popup, position=after_start"/>
<popup id="popup" width="300px">
	<vbox>
		ZK simply rich.
		<toolbarbutton label="ZK your killer Web application now!"
			href="http://www.zkoss.org" />
	</vbox>
</popup>

Position

You can simply specify a popup's position when attaching to a component by

  • built-in position
  • x, y coordinate
<button popup="popup_id, position=overlap_end"/>
<button popup="popup_id, x=50,y=50"/>


Since 6.0.1 ZK supports the following position string:

ZKComRef Popup Position 601.png

overlap, overlap_end, overlap_before, overlap_after are kept (still available) for backward compatibility. They are identical with top_left, top_right, bottom_left, and bottom_right, respectively. 

Before 6.0.0

The 14 possible positions are provided below:

ZKComRef Popup Position.png

The following illustrates the simplicity of usage, 

<popup id="pp">
	Here is popup
</popup>
<button label="before_start" onClick='pp.open(self, "before_start");' />

Upon clicking the button the popup component will appear in the relative position specified. In this case the position is just above the button.

ZKComRef Popup Beforestart.png


Methods

There are several overloading open() methods available, please check javadoc

Toggle Popup

Since 7.0.0 If a popup/context menu is assigned to a target component via the popup/context attribute, the popup will show up when the user clicks on the target component. Click the target component again, the popup will still show up by default. As of 7.0.0, The popup/context attribute supports an additional toggle type, which could make the target component act as a toggle switcher. If the popup has not shown up yet, clicking the target component will cause the popup to show up. If the popup is showing up, clicking on the target component again will toggle the popup to hide. The usage is in the below code. 

<button label="Popup" popup="id, type=toggle"/>

Tooltip Delay

The tooltip attribute can also support a delay, the following code outlines how to accomplish this. 

<label value="Tooltip" tooltip="popup_id, position=before_start, delay=500"/>

Supported Events

Name
Event Type
onOpen
 Event: OpenEvent

Denotes a Popup has been opened or closed (in this case OpenEvent::isOpen() returns false).

Supported Children

*ALL

Use Cases

Version Description Example Location
3.6 Smalltalk: Toolbar and Menus ZK Developer's Reference: Tooltips, Context Menus and Popups
3.6 A way to specify the position of the Popup component New Features of ZK 3.6.1
3.6 Popup, tooltip and context positions New Features of ZK 3.6.3

Version History

Last Update : 2024/01/15


Version Date Content
7.0.0 Nov 2013 Popup support toggle type



Last Update : 2024/01/15

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


Retrieved from "https://www.zkoss.org/_w/index.php?title=ZK_Component_Reference/Essential_Components/Popup&oldid=56547"