Java Doc for UserPrefsTool.java in  » ERP-CRM-Financial » sakai » org » sakaiproject » user » tool » 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 » ERP CRM Financial » sakai » org.sakaiproject.user.tool 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.sakaiproject.user.tool.UserPrefsTool

UserPrefsTool
public class UserPrefsTool (Code)
UserPrefsTool is the Sakai end-user tool to view and edit one's preferences.

Inner Class :public class KeyNameValue

Field Summary
final protected static  StringEXCLUDE_SITE_LISTS
    
final protected static  StringORDER_SITE_LISTS
    
protected  booleanisNewUser
    
protected  booleanlocUpdated
    
protected  PreferencesEditm_edit
     The PreferencesEdit being worked on.
protected  PreferencesServicem_preferencesService
    
protected  Stringm_refreshElement
     The html "peer" element to refresh on the next rendering.
protected  SessionManagerm_sessionManager
    
protected  Collectionm_stuff
     The PreferencesEdit in KeyNameValue collection form.
 ResourceLoadermsgs
    
protected  booleannotiUpdated
    
protected  booleanrefreshUpdated
    
protected  booleantabUpdated
    
protected  booleantzUpdated
    

Constructor Summary
public  UserPrefsTool()
     no-arg constructor.

Method Summary
protected  StringbuildTypePrefsContext(String type, String prefix, String context, Preferences prefs)
     Add the two context references for defaults for this type.
Parameters:
  type - The resource type (i.e.
protected  voidcancelEdit()
     Cancel the edit and cleanup.
public  booleangetLocUpdated()
    
public  StringgetMsgNotiAnn1()
     Returns the ResourceLoader value.
public  StringgetMsgNotiAnn2()
    
public  StringgetMsgNotiAnn3()
    
public  StringgetMsgNotiMail1()
    
public  StringgetMsgNotiMail2()
    
public  StringgetMsgNotiMail3()
    
public  StringgetMsgNotiRsrc1()
    
public  StringgetMsgNotiRsrc2()
    
public  StringgetMsgNotiRsrc3()
    
public  StringgetMsgNotiSyll1()
    
public  StringgetMsgNotiSyll2()
    
public  StringgetMsgNotiSyll3()
    
public  booleangetNotiUpdated()
    
public  ListgetPrefExcludeItems()
    
public  ListgetPrefLocales()
    
public  ListgetPrefOrderItems()
    
public  ListgetPrefTimeZones()
    
public  StringgetRefreshElement()
    
public  StringgetSelectedAnnItem()
    
public  String[]getSelectedExcludeItems()
    
public  StringgetSelectedLocaleName()
    
public  StringgetSelectedLocaleString()
    
public  StringgetSelectedMailItem()
    
public  String[]getSelectedOrderItems()
    
public  StringgetSelectedRefreshItem()
    
public  StringgetSelectedRsrcItem()
    
public  StringgetSelectedSyllItem()
    
public  StringgetSelectedTimeZone()
    
protected  StringgetStringPref(String pref_base, String type, Preferences prefs)
     Retrieve a preference
Parameters:
  pres_base - The name of the group of properties (i.e.
public  booleangetTzUpdated()
    
public  StringgetUserId()
    
protected  booleanhasValue(String eval)
    
protected  intindexOf(String value, List siteList)
     Find the site in the list that has this id - return the position.
public  booleanisPrivacyEnabled()
    
public  booleanisTabUpdated()
    
protected  voidloadNotiData()
    
protected  voidloadRefreshData()
     Load refresh data from stored information.
public  StringprocessActionAdd()
     Process the add command from the edit view.
public  StringprocessActionAddAll()
    
public  StringprocessActionCancel()
     Process the cancel command from the edit view.
public  StringprocessActionEdit()
     Process the edit command.
public  StringprocessActionLocCancel()
    
public  StringprocessActionLocFrmEdit()
     Process the cancel command from the edit view.
public  StringprocessActionLocSave()
     Process the save command from the edit view.
public  StringprocessActionMoveDown()
    
public  StringprocessActionMoveUp()
    
public  StringprocessActionNotiCancel()
    
public  StringprocessActionNotiFrmEdit()
     Process the cancel command from the edit view.
public  StringprocessActionNotiFrmRefresh()
     Process cancel and navigate to list page.
public  StringprocessActionNotiSave()
     Process the save command from the edit view.
public  StringprocessActionPrivFrmEdit()
     Process the cancel command from the edit view.
public  StringprocessActionRefreshCancel()
     Process cancel and navigate to list page.
public  StringprocessActionRefreshFrmEdit()
    
public  StringprocessActionRefreshFrmNoti()
    
public  StringprocessActionRemove()
    
public  StringprocessActionRemoveAll()
    
public  StringprocessActionSave()
     Process the save command from the edit view.
public  StringprocessActionTZFrmEdit()
     Process the cancel command from the edit view.
public  StringprocessActionTzCancel()
    
public  StringprocessActionTzSave()
     Process the save command from the edit view.
protected  voidreadTypePrefs(String type, String prefix, PreferencesEdit edit, String data)
     Read the two context references for defaults for this type from the form.
Parameters:
  type - The resource type (i.e.
protected  voidsaveEdit()
     Save any changed values from the edit and cleanup.
public  voidsetLocUpdated(boolean locUpdated)
    
public  voidsetNotiUpdated(boolean notiUpdated)
    
public  voidsetPrefExcludeItems(List prefExcludeItems)
    
public  voidsetPrefLocales(List prefLocales)
    
public  voidsetPrefOrderItems(List prefOrderItems)
    
public  voidsetPrefTimeZones(List prefTimeZones)
    
public  voidsetPreferencesService(PreferencesService mgr)
    
public  voidsetRefreshElement(String element)
     Set the "peer" html element to refresh on the next rendering.
public  voidsetSelectedAnnItem(String selectedAnnItem)
    
public  voidsetSelectedExcludeItems(String[] selectedExcludeItems)
    
public  voidsetSelectedLocaleString(String selectedLocale)
    
public  voidsetSelectedMailItem(String selectedMailItem)
    
public  voidsetSelectedOrderItems(String[] selectedOrderItems)
    
public  voidsetSelectedRefreshItem(String selectedRefreshItem)
    
public  voidsetSelectedRsrcItem(String selectedRsrcItem)
    
public  voidsetSelectedSyllItem(String selectedSyllItem)
    
public  voidsetSelectedTimeZone(String selectedTimeZone)
    
public  voidsetSessionManager(SessionManager mgr)
    
protected  voidsetStringPref(String pref_base, String type, PreferencesEdit edit, String newval)
     Set an integer preference.
Parameters:
  pres_base - The name of the group of properties (i.e.
public  voidsetTabUpdated(boolean tabUpdated)
    
public  voidsetTzUpdated(boolean tzUpdated)
    
protected  voidsetUserEditingOn()
    
public  voidsetUserId(String userId)
    

Field Detail
EXCLUDE_SITE_LISTS
final protected static String EXCLUDE_SITE_LISTS(Code)



ORDER_SITE_LISTS
final protected static String ORDER_SITE_LISTS(Code)



isNewUser
protected boolean isNewUser(Code)



locUpdated
protected boolean locUpdated(Code)



m_edit
protected PreferencesEdit m_edit(Code)
The PreferencesEdit being worked on.



m_preferencesService
protected PreferencesService m_preferencesService(Code)
Preferences service (injected dependency)



m_refreshElement
protected String m_refreshElement(Code)
The html "peer" element to refresh on the next rendering.



m_sessionManager
protected SessionManager m_sessionManager(Code)
Session manager (injected dependency)



m_stuff
protected Collection m_stuff(Code)
The PreferencesEdit in KeyNameValue collection form.



msgs
ResourceLoader msgs(Code)
Resource bundle messages



notiUpdated
protected boolean notiUpdated(Code)



refreshUpdated
protected boolean refreshUpdated(Code)



tabUpdated
protected boolean tabUpdated(Code)



tzUpdated
protected boolean tzUpdated(Code)




Constructor Detail
UserPrefsTool
public UserPrefsTool()(Code)
no-arg constructor.




Method Detail
buildTypePrefsContext
protected String buildTypePrefsContext(String type, String prefix, String context, Preferences prefs)(Code)
Add the two context references for defaults for this type.
Parameters:
  type - The resource type (i.e. a service name).
Parameters:
  prefix - The prefix for context references.
Parameters:
  context - The context.
Parameters:
  prefs - The full set of preferences.



cancelEdit
protected void cancelEdit()(Code)
Cancel the edit and cleanup.



getLocUpdated
public boolean getLocUpdated()(Code)
Returns the tzUpdated.



getMsgNotiAnn1
public String getMsgNotiAnn1()(Code)
Returns the ResourceLoader value. Note: workaround for element, which doesn't like using the map variable



getMsgNotiAnn2
public String getMsgNotiAnn2()(Code)



getMsgNotiAnn3
public String getMsgNotiAnn3()(Code)



getMsgNotiMail1
public String getMsgNotiMail1()(Code)



getMsgNotiMail2
public String getMsgNotiMail2()(Code)



getMsgNotiMail3
public String getMsgNotiMail3()(Code)



getMsgNotiRsrc1
public String getMsgNotiRsrc1()(Code)



getMsgNotiRsrc2
public String getMsgNotiRsrc2()(Code)



getMsgNotiRsrc3
public String getMsgNotiRsrc3()(Code)



getMsgNotiSyll1
public String getMsgNotiSyll1()(Code)



getMsgNotiSyll2
public String getMsgNotiSyll2()(Code)



getMsgNotiSyll3
public String getMsgNotiSyll3()(Code)



getNotiUpdated
public boolean getNotiUpdated()(Code)
Returns the notiUpdated.



getPrefExcludeItems
public List getPrefExcludeItems()(Code)
Returns the prefExcludeItems.



getPrefLocales
public List getPrefLocales()(Code)
Returns the prefLocales



getPrefOrderItems
public List getPrefOrderItems()(Code)
Returns the prefOrderItems.



getPrefTimeZones
public List getPrefTimeZones()(Code)
Returns the prefTimeZones.



getRefreshElement
public String getRefreshElement()(Code)
Get, and clear, the refresh element The html "peer" element to refresh on the next rendering, or null if none defined.



getSelectedAnnItem
public String getSelectedAnnItem()(Code)
Returns the selectedAnnItem.



getSelectedExcludeItems
public String[] getSelectedExcludeItems()(Code)
Returns the selectedExcludeItems.



getSelectedLocaleName
public String getSelectedLocaleName()(Code)
Returns the user's selected Locale ID



getSelectedLocaleString
public String getSelectedLocaleString()(Code)
Returns the user's selected Locale ID



getSelectedMailItem
public String getSelectedMailItem()(Code)
Returns the selectedMailItem.



getSelectedOrderItems
public String[] getSelectedOrderItems()(Code)
Returns the selectedOrderItems.



getSelectedRefreshItem
public String getSelectedRefreshItem()(Code)
Returns the selectedRefreshItem.



getSelectedRsrcItem
public String getSelectedRsrcItem()(Code)
Returns the selectedRsrcItem.



getSelectedSyllItem
public String getSelectedSyllItem()(Code)



getSelectedTimeZone
public String getSelectedTimeZone()(Code)
Returns the user's selected TimeZone ID



getStringPref
protected String getStringPref(String pref_base, String type, Preferences prefs)(Code)
Retrieve a preference
Parameters:
  pres_base - The name of the group of properties (i.e. a service name)
Parameters:
  type - The particular property
Parameters:
  prefs - The full set of preferences for the current logged in user.



getTzUpdated
public boolean getTzUpdated()(Code)
Returns the tzUpdated.



getUserId
public String getUserId()(Code)
Returns the userId.



hasValue
protected boolean hasValue(String eval)(Code)
Check String has value, not null boolean



indexOf
protected int indexOf(String value, List siteList)(Code)
Find the site in the list that has this id - return the position. *
Parameters:
  value - The site id to find.
Parameters:
  siteList - The list of Site objects. The index position in siteList of the site with site id = value, or -1 if not found.



isPrivacyEnabled
public boolean isPrivacyEnabled()(Code)
Pull whether privacy status should be enabled from sakai.properties



isTabUpdated
public boolean isTabUpdated()(Code)
Returns the tabUpdated.



loadNotiData
protected void loadNotiData()(Code)
Load saved notification data - this is called from cancel button of notification page as navigation stays in the page



loadRefreshData
protected void loadRefreshData()(Code)
Load refresh data from stored information. This is called when navigated into this page for first time.



processActionAdd
public String processActionAdd()(Code)
Process the add command from the edit view. navigation outcome to tab customization page (edit)



processActionAddAll
public String processActionAddAll()(Code)
Process Add All action navigation output to tab customization page (edit)



processActionCancel
public String processActionCancel()(Code)
Process the cancel command from the edit view. navigation outcome to tab customization page (edit)



processActionEdit
public String processActionEdit()(Code)
Process the edit command. navigation outcome to tab customization page (edit)



processActionLocCancel
public String processActionLocCancel()(Code)
process locale cancel navigation outcome to locale page



processActionLocFrmEdit
public String processActionLocFrmEdit()(Code)
Process the cancel command from the edit view. navigation outcome to locale page (list)



processActionLocSave
public String processActionLocSave()(Code)
Process the save command from the edit view. navigation outcome to locale page



processActionMoveDown
public String processActionMoveDown()(Code)
Move down the selected item in Ordered List navigation output to tab customization page (edit)



processActionMoveUp
public String processActionMoveUp()(Code)
Move Up the selected item in Ordered List navigation output to tab customization page (edit)



processActionNotiCancel
public String processActionNotiCancel()(Code)
process notification cancel navigation outcome to notification page



processActionNotiFrmEdit
public String processActionNotiFrmEdit()(Code)
Process the cancel command from the edit view. navigation outcome to Notification page (list)



processActionNotiFrmRefresh
public String processActionNotiFrmRefresh()(Code)
Process cancel and navigate to list page. navigation outcome to notification page



processActionNotiSave
public String processActionNotiSave()(Code)
Process the save command from the edit view. navigation outcome to notification page



processActionPrivFrmEdit
public String processActionPrivFrmEdit()(Code)
Process the cancel command from the edit view. navigation outcome to locale page (list)



processActionRefreshCancel
public String processActionRefreshCancel()(Code)
Process cancel and navigate to list page. navigation outcome to refresh page



processActionRefreshFrmEdit
public String processActionRefreshFrmEdit()(Code)
This is called from edit page for navigation to refresh page navigation outcome to refresh page (refresh)



processActionRefreshFrmNoti
public String processActionRefreshFrmNoti()(Code)
This is called from notification page for navigation to Refresh page navigation outcome to refresh page



processActionRemove
public String processActionRemove()(Code)
Process remove from order list command navigation output to tab customization page (edit)



processActionRemoveAll
public String processActionRemoveAll()(Code)
Process Remove All command navigation output to tab customization page (edit)



processActionSave
public String processActionSave()(Code)
Process the save command from the edit view. navigation outcome to tab customization page (edit)



processActionTZFrmEdit
public String processActionTZFrmEdit()(Code)
Process the cancel command from the edit view. navigation outcome to timezone page (list)



processActionTzCancel
public String processActionTzCancel()(Code)
process timezone cancel navigation outcome to timezone page



processActionTzSave
public String processActionTzSave()(Code)
Process the save command from the edit view. navigation outcome to timezone page



readTypePrefs
protected void readTypePrefs(String type, String prefix, PreferencesEdit edit, String data)(Code)
Read the two context references for defaults for this type from the form.
Parameters:
  type - The resource type (i.e. a service name).
Parameters:
  prefix - The prefix for context references.
Parameters:
  edit - The preferences being edited.
Parameters:
  data - The rundata with the form fields.



saveEdit
protected void saveEdit()(Code)
Save any changed values from the edit and cleanup.



setLocUpdated
public void setLocUpdated(boolean locUpdated)(Code)

Parameters:
  notiUpdated - The locUpdated to set.



setNotiUpdated
public void setNotiUpdated(boolean notiUpdated)(Code)

Parameters:
  notiUpdated - The notiUpdated to set.



setPrefExcludeItems
public void setPrefExcludeItems(List prefExcludeItems)(Code)

Parameters:
  prefExcludeItems - The prefExcludeItems to set.



setPrefLocales
public void setPrefLocales(List prefLocales)(Code)

Parameters:
  prefLocales - The prefLocales to set.



setPrefOrderItems
public void setPrefOrderItems(List prefOrderItems)(Code)

Parameters:
  prefOrderItems - The prefOrderItems to set.



setPrefTimeZones
public void setPrefTimeZones(List prefTimeZones)(Code)

Parameters:
  prefTimeZones - The prefTimeZones to set.



setPreferencesService
public void setPreferencesService(PreferencesService mgr)(Code)

Parameters:
  mgr - The preferences service.



setRefreshElement
public void setRefreshElement(String element)(Code)
Set the "peer" html element to refresh on the next rendering.
Parameters:
  element -



setSelectedAnnItem
public void setSelectedAnnItem(String selectedAnnItem)(Code)

Parameters:
  selectedAnnItem - The selectedAnnItem to set.



setSelectedExcludeItems
public void setSelectedExcludeItems(String[] selectedExcludeItems)(Code)

Parameters:
  selectedExcludeItems - The selectedExcludeItems to set.



setSelectedLocaleString
public void setSelectedLocaleString(String selectedLocale)(Code)

Parameters:
  selectedLocale - The selectedLocale to set.



setSelectedMailItem
public void setSelectedMailItem(String selectedMailItem)(Code)

Parameters:
  selectedMailItem - The selectedMailItem to set.



setSelectedOrderItems
public void setSelectedOrderItems(String[] selectedOrderItems)(Code)

Parameters:
  selectedOrderItems - The selectedOrderItems to set.



setSelectedRefreshItem
public void setSelectedRefreshItem(String selectedRefreshItem)(Code)

Parameters:
  selectedRefreshItem - The selectedRefreshItem to set.



setSelectedRsrcItem
public void setSelectedRsrcItem(String selectedRsrcItem)(Code)

Parameters:
  selectedRsrcItem - The selectedRsrcItem to set.



setSelectedSyllItem
public void setSelectedSyllItem(String selectedSyllItem)(Code)



setSelectedTimeZone
public void setSelectedTimeZone(String selectedTimeZone)(Code)

Parameters:
  selectedTimeZone - The selectedTimeZone to set.



setSessionManager
public void setSessionManager(SessionManager mgr)(Code)

Parameters:
  mgr - The session manager.



setStringPref
protected void setStringPref(String pref_base, String type, PreferencesEdit edit, String newval)(Code)
Set an integer preference.
Parameters:
  pres_base - The name of the group of properties (i.e. a service name)
Parameters:
  type - The particular property
Parameters:
  edit - An edit version of the full set of preferences for the current logged in user.
Parameters:
  newval - The string to be the new preference.



setTabUpdated
public void setTabUpdated(boolean tabUpdated)(Code)

Parameters:
  tabUpdated - The tabUpdated to set.



setTzUpdated
public void setTzUpdated(boolean tzUpdated)(Code)

Parameters:
  notiUpdated - The tzUpdated to set.



setUserEditingOn
protected void setUserEditingOn()(Code)
Set editing mode on for user and add user if not existing



setUserId
public void setUserId(String userId)(Code)

Parameters:
  userId - The userId to set.



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.