Java Doc for IteratorComponent.java in  » Web-Framework » struts-2.0.11 » org » apache » struts2 » components » 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 » Web Framework » struts 2.0.11 » org.apache.struts2.components 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.apache.struts2.components.Component
      org.apache.struts2.components.IteratorComponent

IteratorComponent
public class IteratorComponent extends Component (Code)

Iterator will iterate over a value. An iterable value can be either of: java.util.Collection, java.util.Iterator, java.util.Enumeration, java.util.Map, array.

  • status (String) - if specified, an instanceof IteratorStatus will be pushed into stack upon each iteration
  • value (Object) - the source to iterate over, must be iteratable, else an the object itself will be put into a newly created List (see MakeIterator#convert(Object)
  • id (String) - if specified the current iteration object will be place with this id in Struts stack's context scope

The following example retrieves the value of the getDays() method of the current object on the value stack and uses it to iterate over. The <s:property/> tag prints out the current value of the iterator.

 
 <s:iterator value="days">
 <p>day is: <s:property/></p>
 </s:iterator>
 
 

The following example uses a Bean tag and places it into the ActionContext. The iterator tag will retrieve that object from the ActionContext and then calls its getDays() method as above. The status attribute is also used to create a IteratorStatus object, which in this example, its odd() method is used to alternate row colours:

 
 <s:bean name="org.apache.struts2.example.IteratorExample" id="it">
 <s:param name="day" value="'foo'"/>
 <s:param name="day" value="'bar'"/>
 </s:bean>
 

<table border="0" cellspacing="0" cellpadding="1"> <tr> <th>Days of the week</th> </tr>

<s:iterator value="#it.days" status="rowstatus"> <tr> <s:if test="#rowstatus.odd == true"> <td style="background: grey"><s:property/></td> </s:if> <s:else> <td><s:property/></td> </s:else> </tr> </s:iterator> </table>

The next example will further demonstrate the use of the status attribute, using a DAO obtained from the action class through OGNL, iterating over groups and their users (in a security context). The last() method indicates if the current object is the last available in the iteration, and if not, we need to seperate the users using a comma:

 
 <s:iterator value="groupDao.groups" status="groupStatus">
 <tr class="<s:if test="#groupStatus.odd == true ">odd</s:if><s:else>even</s:else>">
 <td><s:property value="name" /></td>
 <td><s:property value="description" /></td>
 <td>
 <s:iterator value="users" status="userStatus">
 <s:property value="fullName" /><s:if test="!#userStatus.last">,</s:if>
 </s:iterator>
 </td>
 </tr>
 </s:iterator>
 
 

The next example iterates over a an action collection and passes every iterator value to another action. The trick here lies in the use of the '[0]' operator. It takes the current iterator value and passes it on to the edit action. Using the '[0]' operator has the same effect as using >s:property />. (The latter, however, does not work from inside the param tag).

 
 <s:action name="entries" id="entries"/>
 <s:iterator value="#entries.entries" >
 <s:property value="name" />
 <s:property />
 <s:push value="...">
 <s:action name="edit" id="edit" >
 <s:param name="entry" value="[0]" />
 </s:action>
 </push>
 </s:iterator>
 
 

To simulate a simple loop with iterator tag, the following could be done. It does the loop 5 times.
 
 <s:iterator status="stat" value="{1,2,3,4,5}" >
 <!-- grab the index (start with 0 ... ) -->
 <s:property value="#stat.index" />
 <!-- grab the top of the stack which should be the -->
 <!-- current iteration value (0, 1, ... 5) -->
 <s:property value="top" />
 </s:iterator>
 
 


Field Summary
protected  Iteratoriterator
    
protected  ObjectoldStatus
    
protected  IteratorStatusstatus
    
protected  StringstatusAttr
    
protected  IteratorStatus.StatusStatestatusState
    
protected  Stringvalue
    

Constructor Summary
public  IteratorComponent(ValueStack stack)
    

Method Summary
public  booleanend(Writer writer, String body)
    
public  voidsetStatus(String status)
    
public  voidsetValue(String value)
    
public  booleanstart(Writer writer)
    

Field Detail
iterator
protected Iterator iterator(Code)



oldStatus
protected Object oldStatus(Code)



status
protected IteratorStatus status(Code)



statusAttr
protected String statusAttr(Code)



statusState
protected IteratorStatus.StatusState statusState(Code)



value
protected String value(Code)




Constructor Detail
IteratorComponent
public IteratorComponent(ValueStack stack)(Code)




Method Detail
end
public boolean end(Writer writer, String body)(Code)



setStatus
public void setStatus(String status)(Code)



setValue
public void setValue(String value)(Code)



start
public boolean start(Writer writer)(Code)



Fields inherited from org.apache.struts2.components.Component
final public static String COMPONENT_STACK(Code)(Java Doc)
protected ActionMapper actionMapper(Code)(Java Doc)
protected String id(Code)(Java Doc)
protected Map parameters(Code)(Java Doc)
protected ValueStack stack(Code)(Java Doc)

Methods inherited from org.apache.struts2.components.Component
public void addAllParameters(Map params)(Code)(Java Doc)
public void addParameter(String key, Object value)(Code)(Java Doc)
public boolean altSyntax()(Code)(Java Doc)
public void copyParams(Map params)(Code)(Java Doc)
protected String determineActionURL(String action, String namespace, String method, HttpServletRequest req, HttpServletResponse res, Map parameters, String scheme, boolean includeContext, boolean encodeResult)(Code)(Java Doc)
protected String determineActionURL(String action, String namespace, String method, HttpServletRequest req, HttpServletResponse res, Map parameters, String scheme, boolean includeContext, boolean encodeResult, boolean forceAddSchemeHostAndPort, boolean escapeAmp)(Code)(Java Doc)
protected String determineNamespace(String namespace, ValueStack stack, HttpServletRequest req)(Code)(Java Doc)
public boolean end(Writer writer, String body)(Code)(Java Doc)
protected boolean end(Writer writer, String body, boolean popComponentStack)(Code)(Java Doc)
protected StrutsException fieldError(String field, String errorMsg, Exception e)(Code)(Java Doc)
protected Component findAncestor(Class clazz)(Code)(Java Doc)
protected String findString(String expr)(Code)(Java Doc)
protected String findString(String expr, String field, String errorMsg)(Code)(Java Doc)
protected Object findValue(String expr)(Code)(Java Doc)
protected Object findValue(String expr, String field, String errorMsg)(Code)(Java Doc)
protected Object findValue(String expr, Class toType)(Code)(Java Doc)
public Stack getComponentStack()(Code)(Java Doc)
public String getId()(Code)(Java Doc)
public Map getParameters()(Code)(Java Doc)
public ValueStack getStack()(Code)(Java Doc)
protected void popComponentStack()(Code)(Java Doc)
public void setActionMapper(ActionMapper mapper)(Code)(Java Doc)
public void setId(String id)(Code)(Java Doc)
public boolean start(Writer writer)(Code)(Java Doc)
protected String toString(Throwable t)(Code)(Java Doc)
public boolean usesBody()(Code)(Java Doc)

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.