Java Doc for WidgetFinder.java in  » Content-Management-System » apache-lenya-2.0 » org » apache » cocoon » forms » util » 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 » Content Management System » apache lenya 2.0 » org.apache.cocoon.forms.util 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.apache.cocoon.forms.util.WidgetFinder

WidgetFinder
public class WidgetFinder (Code)
An utility class to manage list of widgets.

The org.apache.cocoon.forms.formmodel.Widget.lookupWidget(String) method is able to only return one widget, while this class returns a list of widgets. It uses a path syntax containing a /./, repeater/./foo, which repreesents all the instances of the foo widget inside the repeater, one per row. Note that it also supports finding a widgets inside multi level repeaters, something like invoices/./movements/./amount or courseYears/./exams/./preparatoryCourses/./title .

Class has been designed to offer good performances, since the widget list is built only once and is automatically updated when a repeater row is added or removed. org.apache.cocoon.forms.event.RepeaterListener s can be attached directly to receive notifications of widget additions or removals.

This class is used in org.apache.cocoon.forms.formmodel.CalculatedField s and org.apache.cocoon.forms.formmodel.CalculatedFieldAlgorithm s.


version:
   $Id$

Inner Class :class RefreshingRepeaterListener implements RepeaterListener


Constructor Summary
public  WidgetFinder(Widget context, Iterator paths, boolean keepUpdated)
     Searches for widgets.
public  WidgetFinder(Widget context, String path, boolean keepUpdated)
     Searches for widgets.

Method Summary
public  voidaddRepeaterListener(RepeaterListener listener)
     Adds a repeater listener.
public  ListgetNewAdditions()
     Gets the new widgets that has been added to the list, as a consequence of new repeater rows additions, since last time this method was called or the finder was initialized.
public  CollectiongetWidgets()
     Return all widgets found for the given paths.
public  booleanhasNewAdditions()
     true if new widgets have been added to this list (i.e.
public  booleanhasRepeaterListeners()
     true if there are listeners registered on this instance.
public  booleanisMutable()
     true if this finder is mutable (i.e.
protected  voidrefreshForAdd(Repeater repeater, int index)
     Called when a new row addition event is received from a monitored repeater.
protected  voidrefreshForClear(Repeater repeater)
     Called when a repeater clear event is received from a monitored repeater.
protected  voidrefreshForDelete(Repeater repeater, int index)
     Called when a row deletion event is received from a monitored repeater.
public  voidremoveRepeaterListener(RepeaterListener listener)
     Removes a listener.


Constructor Detail
WidgetFinder
public WidgetFinder(Widget context, Iterator paths, boolean keepUpdated)(Code)
Searches for widgets. It will iterate on the given paths and find all corresponding widgets. If a path is in the forms repeater/* /widget then all the rows of the repeater will be iterated and subwidgets will be fetched.
Parameters:
  context - The context widget to start from.
Parameters:
  paths - An iterator of Strings containing the paths.
Parameters:
  keepUpdated - If true, listeners will be installed on repeatersto keep lists updated without polling.



WidgetFinder
public WidgetFinder(Widget context, String path, boolean keepUpdated)(Code)
Searches for widgets. If path is in the forms repeater/* /widget then all the rows of the repeater will be iterated and subwidgets will be fetched.
Parameters:
  context - The context widget to start from.
Parameters:
  path - Path to search for..
Parameters:
  keepUpdated - If true, listeners will be installed on repeatersto keep lists updated without polling.




Method Detail
addRepeaterListener
public void addRepeaterListener(RepeaterListener listener)(Code)
Adds a repeater listener. New widget additions or deletions will be notified thru this listener (events received from monitored repeaters will be forwarded, use WidgetFinder.getNewAdditions() to retrieve new widgets).
Parameters:
  listener - The listener to add.



getNewAdditions
public List getNewAdditions()(Code)
Gets the new widgets that has been added to the list, as a consequence of new repeater rows additions, since last time this method was called or the finder was initialized. A List of Widgets.



getWidgets
public Collection getWidgets()(Code)
Return all widgets found for the given paths. A Collection of Widgets.



hasNewAdditions
public boolean hasNewAdditions()(Code)
true if new widgets have been added to this list (i.e. new repeater rows have been created) since last time getNewAdditions() was called.



hasRepeaterListeners
public boolean hasRepeaterListeners()(Code)
true if there are listeners registered on this instance. See WidgetFinder.addRepeaterListener(RepeaterListener).



isMutable
public boolean isMutable()(Code)
true if this finder is mutable (i.e. it's monitoring some repeaters) or false if getWidgets() will always return the same list (i.e. it's not monitoring any widget).



refreshForAdd
protected void refreshForAdd(Repeater repeater, int index)(Code)
Called when a new row addition event is received from a monitored repeater.
Parameters:
  repeater - The repeated that generated the event.
Parameters:
  index - The new row index.



refreshForClear
protected void refreshForClear(Repeater repeater)(Code)
Called when a repeater clear event is received from a monitored repeater.
Parameters:
  repeater - The repeated that generated the event.



refreshForDelete
protected void refreshForDelete(Repeater repeater, int index)(Code)
Called when a row deletion event is received from a monitored repeater.
Parameters:
  repeater - The repeated that generated the event.
Parameters:
  index - The deleted row index.



removeRepeaterListener
public void removeRepeaterListener(RepeaterListener listener)(Code)
Removes a listener. See WidgetFinder.addRepeaterListener(RepeaterListener) .
Parameters:
  listener - The listener to remove.



Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(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.