Java Doc for IBreadCrumbModel.java in  » J2EE » wicket » org » apache » wicket » extensions » breadcrumb » 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 » J2EE » wicket » org.apache.wicket.extensions.breadcrumb 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


org.apache.wicket.extensions.breadcrumb.IBreadCrumbModel

All known Subclasses:   org.apache.wicket.extensions.breadcrumb.BreadCrumbBar,
IBreadCrumbModel
public interface IBreadCrumbModel extends IClusterable(Code)
Bread crumbs provide a means to track certain history of client actions. Bread crumbs are typically rendered as a list of links, and are useful when users 'dig deeper' into the site structure so that they can find their way back again and have a notion of where they currently are.

Bread crumbs in the original sense just represent where people are in a site hierarchy. For example, when browsing a product site, bread crumbs could look like this:

 Home > Products & Solutions > Hardware > Desktop Systems
 
or
 World > Europe > The Netherlands > Utrecht
 
These items would be rendered as links to the corresponding site location.

Classes that implement this interface are responsible for managing such a bread crumb structure. A BreadCrumbBar typical implementation regards bread crumbs as a stack. When IBreadCrumbModel.setActive(IBreadCrumbParticipant) a bread crumb is activated that was not in the stack yet, it would add it to the stack, or when a bread crumb is activated that is already on the stack, it would roll back to the corresponding depth.

This model does not make any presumptions on how it should interact with components. Just that there is a list of IBreadCrumbParticipant bread crumb participants , and the notion of a currently active bread crumb participant.

A IBreadCrumbParticipant bread crumb participant is not an actual bread crump, but rather a proxy to components that represent a certain location relative to other bread crumbs in this model, and a means to get the bread crumb title, which is typically rendered as a link label of the actual bread crumb. The actual bread crumbs are supposed to be rendered by a component that works together with this model. I choose this model as this would suit what I think is one of the nicest patterns: BreadCrumbPanel bread crumb aware panels .


author:
   Eelco Hillenius




Method Summary
 voidaddListener(IBreadCrumbModelListener listener)
     Adds a bread crumb model listener.
 ListallBreadCrumbParticipants()
     Lists the bread crumb participants in this model.
 IBreadCrumbParticipantgetActive()
     Gets the currently active participant, if any.
 voidremoveListener(IBreadCrumbModelListener listener)
     Removes a bread crumb model listener.
 voidsetActive(IBreadCrumbParticipant breadCrumbParticipant)
     Sets the IBreadCrumbParticipant bread crumb as the active one.



Method Detail
addListener
void addListener(IBreadCrumbModelListener listener)(Code)
Adds a bread crumb model listener.
Parameters:
  listener - The listener to add



allBreadCrumbParticipants
List allBreadCrumbParticipants()(Code)
Lists the bread crumb participants in this model. The bread crumbs particpants, as list withIBreadCrumbParticipant bread crumb participants.



getActive
IBreadCrumbParticipant getActive()(Code)
Gets the currently active participant, if any. The currently active participant, may be null



removeListener
void removeListener(IBreadCrumbModelListener listener)(Code)
Removes a bread crumb model listener.
Parameters:
  listener - The listener to remove



setActive
void setActive(IBreadCrumbParticipant breadCrumbParticipant)(Code)
Sets the IBreadCrumbParticipant bread crumb as the active one. Implementations should call IBreadCrumbModelListener.breadCrumbAdded(IBreadCrumbParticipant) bread crumb added when the bread crumb was not yet part of the model, and IBreadCrumbModelListener.breadCrumbRemoved(IBreadCrumbParticipant) bread crumb removed for every crumb that was removed as the result of this call.
Parameters:
  breadCrumbParticipant - The bread crump that should be set as the currently active



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