Java Doc for Combobox.java in  » Ajax » zk » org » zkoss » zul » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Ajax » zk » org.zkoss.zul 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


org.zkoss.zul.Textbox
   org.zkoss.zul.Combobox

Combobox
public class Combobox extends Textbox (Code)
A combo box.

Non-XUL extension. It is used to replace XUL menulist. This class is more flexible than menulist, such as Combobox.setAutocompleteCombobox.setAutodrop .

Default Combobox.getSclass : combobox.

Events: onOpen, onSelect
Developers can listen to the onOpen event and initializes it when org.zkoss.zk.ui.event.OpenEvent.isOpen is true, and/or clean up if false.

Besides assign a list model, you could assign a renderer (a ComboitemRenderer instance) to a combobox, such that the combobox will use this renderer to render the data returned by ListModel.getElementAt . If not assigned, the default renderer, which assumes a label per combo item, is used. In other words, the default renderer adds a label to a row by calling toString against the object returned by ListModel.getElementAt . (since 3.0.2)

Note: to have better performance, onOpen is sent only if a non-deferrable event listener is registered (see org.zkoss.zk.ui.event.Deferrable ).
author:
   tomyeh
See Also:   Comboitem


Inner Class :protected class ExtraCtrl extends Textbox.ExtraCtrl implements ChildChangedAware,Selectable


Constructor Summary
public  Combobox()
    
public  Combobox(String value)
    

Method Summary
public  ComboitemappendItem(String label)
     Appends an item.
public  Objectclone()
    
public  voidclose()
     Closes the list of combo items ( Comboitem if it was dropped down.
protected  StringcoerceToString(Object value)
    
public  StringgetImage()
     Returns the URI of the button image.
public  StringgetInnerAttrs()
    
public  ComboitemgetItemAtIndex(int index)
     Returns the item at the specified index.
public  intgetItemCount()
     Returns the number of items.
public  ComboitemRenderergetItemRenderer()
     Returns the renderer to render each row, or null if the default renderer is used.
public  ListgetItems()
     Returns a 'live' list of all Comboitem . By live we mean you can add or remove them directly with the List interface.

Currently, it is the same as Combobox.getChildren .

public  ListModelgetModel()
     Returns the list model associated with this combobox, or null if this combobox is not associated with any list data model.
public  StringgetOuterAttrs()
    
protected  intgetRealStyleFlags()
     Returns RS_NO_WIDTH|RS_NO_HEIGHT.
public  intgetSelectedIndex()
     Returns the index of the selected item, or -1 if not selected.
public  ComboitemgetSelectedItem()
     Returns the selected item.
public  booleaninsertBefore(Component newChild, Component refChild)
    
public  booleanisAutocomplete()
     Returns whether to automatically complete this text box by matching the nearest item ( Comboitem .

Default: false.

If true, the nearest item will be searched and the text box is updated automatically. If false, user has to click the item or use the DOWN or UP keys to select it back.

Note: this feature is reserved and not yet implemented. Don't confuse it with the auto-completion feature mentioned by other framework.

public  booleanisAutodrop()
     Returns whether to automatically drop the list if users is changing this text box.
public  booleanisButtonVisible()
     Returns whether the button (on the right of the textbox) is visible.
public  booleanisChildable()
     Childable.
protected  ObjectnewExtraCtrl()
    
public  voidonChildAdded(Component child)
    
public  voidonChildRemoved(Component child)
    
public  voidonInitRender(Event data)
     Handles a private event, onInitRender.
public  voidopen()
     Drops down the list of combo items ( Comboitem .
final  voidreIndex()
    
public  ComboitemremoveItemAt(int index)
     Removes the child item in the list box at the given index.
public  voidsetAutocomplete(boolean autocomplete)
     Sets whether to automatically complete this text box by matching the nearest item ( Comboitem .
public  voidsetAutodrop(boolean autodrop)
     Sets whether to automatically drop the list if users is changing this text box.
public  voidsetButtonVisible(boolean visible)
     Sets whether the button (on the right of the textbox) is visible.
public  voidsetImage(String img)
     Sets the URI of the button image.
Parameters:
  img - the URI of the button image.
public  voidsetItemRenderer(ComboitemRenderer renderer)
     Sets the renderer which is used to render each row if Combobox.getModel is not null.
public  voidsetItemRenderer(String clsnm)
     Sets the renderer by use of a class name.
public  voidsetModel(ListModel model)
     Sets the list model associated with this combobox.
public  voidsetMultiline(boolean multiline)
    
public  voidsetOpen(boolean open)
     Drops down or closes the list of combo items ( Comboitem .
public  voidsetRows(int rows)
    
public  voidsetSelectedIndex(int jsel)
     Deselects the currently selected items and selects the item with the given index.
public  voidsetSelectedItem(Comboitem item)
     Deselects the currently selected items and selects the given item.


Constructor Detail
Combobox
public Combobox()(Code)



Combobox
public Combobox(String value) throws WrongValueException(Code)




Method Detail
appendItem
public Comboitem appendItem(String label)(Code)
Appends an item.



clone
public Object clone()(Code)



close
public void close()(Code)
Closes the list of combo items ( Comboitem if it was dropped down. It is the same as setOpen(false).
since:
   3.0.1



coerceToString
protected String coerceToString(Object value)(Code)



getImage
public String getImage()(Code)
Returns the URI of the button image.
since:
   2.4.1



getInnerAttrs
public String getInnerAttrs()(Code)



getItemAtIndex
public Comboitem getItemAtIndex(int index)(Code)
Returns the item at the specified index.



getItemCount
public int getItemCount()(Code)
Returns the number of items.



getItemRenderer
public ComboitemRenderer getItemRenderer()(Code)
Returns the renderer to render each row, or null if the default renderer is used.
since:
   3.0.2



getItems
public List getItems()(Code)
Returns a 'live' list of all Comboitem . By live we mean you can add or remove them directly with the List interface.

Currently, it is the same as Combobox.getChildren . However, we might add other kind of children in the future.




getModel
public ListModel getModel()(Code)
Returns the list model associated with this combobox, or null if this combobox is not associated with any list data model.

Note: for implementation of auto-complete, the result of Combobox.getItemCount() is a subset of model. So, if the model implemented ListSubModel interface, you can't use the index of model to find the comboitem by Combobox.getItemAtIndex(int) .
since:
   3.0.2
See Also:   ListSubModel.getSubModel(Objectint)




getOuterAttrs
public String getOuterAttrs()(Code)



getRealStyleFlags
protected int getRealStyleFlags()(Code)
Returns RS_NO_WIDTH|RS_NO_HEIGHT.



getSelectedIndex
public int getSelectedIndex()(Code)
Returns the index of the selected item, or -1 if not selected.
since:
   3.0.1



getSelectedItem
public Comboitem getSelectedItem()(Code)
Returns the selected item.
since:
   2.4.0



insertBefore
public boolean insertBefore(Component newChild, Component refChild)(Code)



isAutocomplete
public boolean isAutocomplete()(Code)
Returns whether to automatically complete this text box by matching the nearest item ( Comboitem .

Default: false.

If true, the nearest item will be searched and the text box is updated automatically. If false, user has to click the item or use the DOWN or UP keys to select it back.

Note: this feature is reserved and not yet implemented. Don't confuse it with the auto-completion feature mentioned by other framework. Such kind of auto-completion is supported well by listening to the onChanging event.




isAutodrop
public boolean isAutodrop()(Code)
Returns whether to automatically drop the list if users is changing this text box.

Default: false.




isButtonVisible
public boolean isButtonVisible()(Code)
Returns whether the button (on the right of the textbox) is visible.

Default: true.




isChildable
public boolean isChildable()(Code)
Childable.



newExtraCtrl
protected Object newExtraCtrl()(Code)



onChildAdded
public void onChildAdded(Component child)(Code)



onChildRemoved
public void onChildRemoved(Component child)(Code)



onInitRender
public void onInitRender(Event data)(Code)
Handles a private event, onInitRender. It is used only for implementation, and you rarely need to invoke it explicitly.
since:
   3.0.2



open
public void open()(Code)
Drops down the list of combo items ( Comboitem . It is the same as setOpen(true).
since:
   3.0.1



reIndex
final void reIndex()(Code)



removeItemAt
public Comboitem removeItemAt(int index)(Code)
Removes the child item in the list box at the given index. the removed item.



setAutocomplete
public void setAutocomplete(boolean autocomplete)(Code)
Sets whether to automatically complete this text box by matching the nearest item ( Comboitem .



setAutodrop
public void setAutodrop(boolean autodrop)(Code)
Sets whether to automatically drop the list if users is changing this text box.



setButtonVisible
public void setButtonVisible(boolean visible)(Code)
Sets whether the button (on the right of the textbox) is visible.



setImage
public void setImage(String img)(Code)
Sets the URI of the button image.
Parameters:
  img - the URI of the button image. If null or empty, the defaultURI is used.
since:
   2.4.1



setItemRenderer
public void setItemRenderer(ComboitemRenderer renderer)(Code)
Sets the renderer which is used to render each row if Combobox.getModel is not null.

Note: changing a render will not cause the combobox to re-render. If you want it to re-render, you could assign the same model again (i.e., setModel(getModel())), or fire an ListDataEvent event.
Parameters:
  renderer - the renderer, or null to use the default.
exception:
  UiException - if failed to initialize with the model
since:
   3.0.2




setItemRenderer
public void setItemRenderer(String clsnm) throws ClassNotFoundException, NoSuchMethodException, IllegalAccessException, InstantiationException, java.lang.reflect.InvocationTargetException(Code)
Sets the renderer by use of a class name. It creates an instance automatically.
since:
   3.0.2



setModel
public void setModel(ListModel model)(Code)
Sets the list model associated with this combobox. If a non-null model is assigned, no matter whether it is the same as the previous, it will always cause re-render.
Parameters:
  model - the list model to associate, or null to dis-associateany previous model.
exception:
  UiException - if failed to initialize with the model
since:
   3.0.2



setMultiline
public void setMultiline(boolean multiline)(Code)



setOpen
public void setOpen(boolean open)(Code)
Drops down or closes the list of combo items ( Comboitem .
since:
   3.0.1
See Also:   Combobox.open
See Also:   Combobox.close



setRows
public void setRows(int rows)(Code)



setSelectedIndex
public void setSelectedIndex(int jsel)(Code)
Deselects the currently selected items and selects the item with the given index.

Note: if the label of comboitem has the same more than one, the first comboitem will be selected at client side, it is a limitation of Combobox and it is different from Listbox .


since:
   3.0.2



setSelectedItem
public void setSelectedItem(Comboitem item)(Code)
Deselects the currently selected items and selects the given item.

Note: if the label of comboitem has the same more than one, the first comboitem will be selected at client side, it is a limitation of Combobox and it is different from Listbox .


since:
   3.0.2



Methods inherited from org.zkoss.zul.Textbox
protected Object coerceFromString(String value) throws WrongValueException(Code)(Java Doc)
protected String coerceToString(Object value)(Code)(Java Doc)
public String getInnerAttrs()(Code)(Java Doc)
public String getOuterAttrs()(Code)(Java Doc)
public int getRows()(Code)(Java Doc)
public String getType()(Code)(Java Doc)
public String getValue() throws WrongValueException(Code)(Java Doc)
public boolean isMultiline()(Code)(Java Doc)
public void setMultiline(boolean multiline)(Code)(Java Doc)
public void setRows(int rows) throws WrongValueException(Code)(Java Doc)
public void setType(String type) throws WrongValueException(Code)(Java Doc)
public void setValue(String value) throws WrongValueException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.