Toolbarbutton"
Jumperchen (talk | contribs) |
Tmillsclare (talk | contribs) m (→Toggle Mode) |
||
(8 intermediate revisions by 4 users not shown) | |||
Line 3: | Line 3: | ||
= Toolbarbutton = | = Toolbarbutton = | ||
− | *Demonstration: [http://www.zkoss.org/zkdemo/menu/toolbar Toolbar] and [ | + | *Demonstration: [http://www.zkoss.org/zkdemo/menu/toolbar Toolbar] and [[Small_Talks/2009/July/ZK_5:_New_File_Upload#Live_Demo |Fileupload]] |
*Java API: <javadoc>org.zkoss.zul.Toolbarbutton</javadoc> | *Java API: <javadoc>org.zkoss.zul.Toolbarbutton</javadoc> | ||
*JavaScript API: <javadoc directory="jsdoc">zul.wgt.Toolbarbutton</javadoc> | *JavaScript API: <javadoc directory="jsdoc">zul.wgt.Toolbarbutton</javadoc> | ||
− | *Style Guide: [ | + | *Style Guide: [[ZK_Style_Guide/XUL_Component_Specification/Toolbarbutton| Toolbarbutton]] |
= Employment/Purpose = | = Employment/Purpose = | ||
− | The | + | The behavior of <tt>Toolbarbutton</tt> is similar to the <tt>button </tt>except the appearance is different. The <tt>button </tt>component uses HTML BUTTON tag, while the <tt>toolbarbutton </tt>component uses HTML DIV tag. |
A <tt>toolbarbutton </tt>could be placed outside a <tt>toolbar</tt>. However <tt>toolbarbutton</tt>s change their appearance if they are placed inside a <tt>toolbar</tt>. | A <tt>toolbarbutton </tt>could be placed outside a <tt>toolbar</tt>. However <tt>toolbarbutton</tt>s change their appearance if they are placed inside a <tt>toolbar</tt>. | ||
Line 16: | Line 16: | ||
− | Within ZK 5, the file upload has been redesigned so it can be integrated with any widget. For example, | + | Within ZK 5, the file upload has been redesigned so it can be integrated with any widget. For example, the toolbarbutton can now be used to upload a file. In addition to this, the display of the upload status has been enhanced and can be customized easily. |
See also : [[ZK_Component_Reference/Essential_Components/Button | Button]], [[ZK_Component_Reference/Essential_Components/Toolbar | Toolbar]] | See also : [[ZK_Component_Reference/Essential_Components/Button | Button]], [[ZK_Component_Reference/Essential_Components/Toolbar | Toolbar]] | ||
+ | |||
= Example = | = Example = | ||
Line 43: | Line 44: | ||
orient="vertical" dir="reverse" /> | orient="vertical" dir="reverse" /> | ||
</hbox> | </hbox> | ||
+ | </window> | ||
+ | </source> | ||
+ | |||
+ | = Toggle Mode = | ||
+ | Toolbarbutton support toggle mode since ZK 6.0.0 . (mode="toggle" ) | ||
+ | |||
+ | [[Image:Toolbarbutton togglemode.png]] | ||
+ | |||
+ | In the toggle mode , the toolbarbutton will be persistent checked after user clicked it, and will be released after next click. | ||
+ | It will fire <javadoc>org.zkoss.zk.ui.event.CheckEvent</javadoc> when state changed. | ||
+ | |||
+ | <source lang="xml" > | ||
+ | <window title="Toolbarbutton" border="normal" width="250px" > | ||
+ | <toolbar > | ||
+ | <toolbarbutton label="File system" mode="toggle" > | ||
+ | <attribute name="onCheck"><![CDATA[ | ||
+ | if(event.isChecked()){ | ||
+ | result.setValue("Activated:"+event.getTarget().getLabel()); | ||
+ | }else{ | ||
+ | result.setValue("Deactivated:"+event.getTarget().getLabel()); | ||
+ | } | ||
+ | ]]></attribute> | ||
+ | </toolbarbutton> | ||
+ | </toolbar> | ||
+ | |||
+ | <label id="result" /> | ||
</window> | </window> | ||
</source> | </source> | ||
Line 70: | Line 97: | ||
! <center>Event Type</center> | ! <center>Event Type</center> | ||
|- | |- | ||
− | | | + | | <center>onCheck</center> |
− | | | + | | '''Event:''' <javadoc>org.zkoss.zk.ui.event.CheckEvent</javadoc> |
+ | Denotes when toolbarbutton is checked , only available in toggle mode . (since ZK 6.0.0) | ||
|} | |} | ||
*Inherited Supported Events: [[ZK_Component_Reference/Essential_Components/Button#Supported_Events | Button]] | *Inherited Supported Events: [[ZK_Component_Reference/Essential_Components/Button#Supported_Events | Button]] | ||
Line 93: | Line 121: | ||
{| border='1px' | width="100%" | {| border='1px' | width="100%" | ||
! Version !! Date !! Content | ! Version !! Date !! Content | ||
+ | |- | ||
+ | | 6.0.0 | ||
+ | | 2/10 | ||
+ | | Introduce Toggle Mode to Toobarbutton | ||
|- | |- | ||
| | | |
Revision as of 11:29, 10 February 2012
Toolbarbutton
- Demonstration: Toolbar and Fileupload
- Java API: Toolbarbutton
- JavaScript API: Toolbarbutton
- Style Guide: Toolbarbutton
Employment/Purpose
The behavior of Toolbarbutton is similar to the button except the appearance is different. The button component uses HTML BUTTON tag, while the toolbarbutton component uses HTML DIV tag.
A toolbarbutton could be placed outside a toolbar. However toolbarbuttons change their appearance if they are placed inside a toolbar.
Toolbarbutton supports getHref(). If getHref() is not null, the onClick handler is ignored and this element is degenerated to HTML's A tag.
Within ZK 5, the file upload has been redesigned so it can be integrated with any widget. For example, the toolbarbutton can now be used to upload a file. In addition to this, the display of the upload status has been enhanced and can be customized easily.
Example
<window title="toolbar demo" border="normal" width="300px">
<caption>
<toolbarbutton label="button3" image="/img/network.gif" />
<space />
<toolbarbutton label="button4" image="/img/network.gif"
dir="reverse" />
</caption>
<toolbar>
<toolbarbutton label="button1" image="/img/network.gif" />
<space />
<toolbarbutton label="button2" image="/img/network.gif" />
</toolbar>
<hbox>
<toolbarbutton label="button5" image="/img/network.gif"
orient="vertical" />
<space />
<toolbarbutton label="button6" image="/img/network.gif"
orient="vertical" dir="reverse" />
</hbox>
</window>
Toggle Mode
Toolbarbutton support toggle mode since ZK 6.0.0 . (mode="toggle" )
In the toggle mode , the toolbarbutton will be persistent checked after user clicked it, and will be released after next click. It will fire CheckEvent when state changed.
<window title="Toolbarbutton" border="normal" width="250px" >
<toolbar >
<toolbarbutton label="File system" mode="toggle" >
<attribute name="onCheck"><![CDATA[
if(event.isChecked()){
result.setValue("Activated:"+event.getTarget().getLabel());
}else{
result.setValue("Deactivated:"+event.getTarget().getLabel());
}
]]></attribute>
</toolbarbutton>
</toolbar>
<label id="result" />
</window>
File Upload
Any toolbarbutton[1] can be used to upload files. All you need to do is:
- Specify the upload attribute with true
- Handles the onUpload event.
<toolbarbutton upload="true" label="Fileupload" onUpload="myProcessUpload(event.getMedia())"/>
When the file is uploaded, an instance of UploadEvent is sent to the button. Then, the event listener can retrieve the uploaded content by examining the return value of UploadEvent.getMedia().
Supported Events
Event: CheckEvent
Denotes when toolbarbutton is checked , only available in toggle mode . (since ZK 6.0.0) |
- Inherited Supported Events: Button
Supported Children
*NONE
Use Cases
Version | Description | Example Location |
---|---|---|
Version History
Version | Date | Content |
---|---|---|
6.0.0 | 2/10 | Introduce Toggle Mode to Toobarbutton |