ViewBean (sakai-rwiki-tool 10.3 API)

java.lang.Object
- uk.ac.cam.caret.sakai.rwiki.tool.bean.ViewBean

Direct Known Subclasses:

AuthZGroupBean, AuthZGroupEditBean, HistoryBean
```
public class ViewBean
extends Object
```
This bean is a helper bean for the view view.

Author:

andrew

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ACTION_PARAM` Parameter name for the parameter indicating what action is required
`protected static String`	`ACTION_URL_ENCODED`
`protected static String`	`DISBLE_BREADCRUMBS_ENCODED`
`static String`	`MAIN_PANEL` Value of the parameter panel that indicates the main panel
`protected static String`	`MAIN_URL_ENCODED`
`static String`	`PAGE_NAME_PARAM` Parameter name for the paramater indicating which pageName to view, edit etc.
`protected static String`	`PAGE_URL_ENCODED`
`protected static String`	`PAGENAME_URL_ENCODED`
`static String`	`PANEL_PARAM` Parameter name for the parameter indicating which panel to use
`protected static String`	`PANEL_URL_ENCODED`
`static String`	`PARAM_BREADCRUMB_NAME` Parameter name for the paramater indicating which pageName to view, edit etc.
`protected static String`	`REALM_URL_ENCODED`
`protected static String`	`SEARCH_URL_ENCODED`

Constructor Summary

Constructors
Constructor and Description
`ViewBean()` Simple constructor that creates an empty view bean.
`ViewBean(String name, String defaultSpace)` Creates a ViewBean and set's the interested page name and local space

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`getActionUrl(String pageName, WikiPageAction action, boolean breadcrumbs)` Given a WikiPageAction return an url to the requested page (with breadcrumbs on or off) for performing that action.
`String`	`getActionUrl(String pageName, WikiPageAction action, Map parameters)` Given a WikiPageAction return an url to the requested page with the additional parameters being set.
`String`	`getActionUrl(WikiPageAction action)` Given a WikiPageAction return an url to the current page for performing that action.
`String`	`getActionUrl(WikiPageAction action, boolean breadcrumbs)` Given a WikiPageAction return an url to the current page (with breadcrumbs on or off) for performing that action.
`String`	`getActionUrl(WikiPageAction action, Map parameters)` Given a WikiPageAction return an url to the current page with the additional parameters being set.
`String`	`getAnchor()` Get the current anchor name
`String`	`getBaseAccessUrl()`
`String`	`getEditCommentURL()`
`String`	`getEditUrl()` Returns a string representation of an url to edit the current page
`String`	`getEditUrl(String name)` Returns a string representation of an url to edit the passed in page.
`String`	`getExportUrl()` Returns a public view URL with no breadcrumbs
`String`	`getHistoryUrl()`
`String`	`getHistoryUrl(String name)`
`String`	`getInfoUrl()` Returns a string representation of an url to view information about the current page
`String`	`getInfoUrl(String name)` Returns a string representation of an url to view information about the passed in page
`String`	`getListCommentsURL()`
`String`	`getListPageChatURL()`
`String`	`getListPresenceURL()`
`String`	`getListSpaceChatURL()`
`String`	`getLocalName()` The page name localised against the localSpace
`String`	`getLocalSpace()` The localSpace
`String`	`getNewCommentURL()`
`String`	`getOpenPageChatURL()`
`String`	`getOpenSpaceChatURL()`
`String`	`getPageName()` The Globalised Page Name
`String`	`getPageSpace()` The space of that the page is in
`protected String`	`getPageUrl(String pageName, String action)` Given a page name and an action return an url that represents it.
`protected String`	`getPageUrl(String pageName, String action, boolean withBreadcrumbs)` Given a page name and an action return an url that represents it.
`protected String`	`getPageUrl(String pageName, String action, Map params)`
`String`	`getPreferencesUrl()`
`String`	`getPrintViewUrl()` Returns a print view URL with no breadcrumbs
`String`	`getPrintViewUrl(boolean withBreadcrumbs)` Returns a string representation of an url to perma view the current page
`String`	`getPublicViewUrl()` Returns a public view URL with no breadcrumbs
`String`	`getPublicViewUrl(boolean withBreadcrumbs)` Returns a string representation of an url to perma view the current page
`String`	`getRssAccessUrl()`
`String`	`getSearch()` The current search criteria XXX This shouldn't be here!
`protected String`	`getSearchUrl()` Creates an appropriate url for searching for the given criteria.
`String`	`getViewUrl()` Returns a string representation of an url to view the current page
`String`	`getViewUrl(String name)` Returns a string representation of an url to view the passed in page
`void`	`setAnchor(String anchor)` Set the current anchor
`void`	`setLocalSpace(String localSpace)` Set the localSpace
`void`	`setPageName(String pageName)` Set the globalised page name
`void`	`setSearch(String search)` Set the current search criteria XXX This shouldn't be here!
`static String`	`urlEncode(String toEncode)` Takes a string to encode and encodes it as a UTF-8 URL-Encoded string.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - PANEL_PARAM
```
public static final String PANEL_PARAM
```
    Parameter name for the parameter indicating which panel to use
    
    See Also:
    Constant Field Values
  - MAIN_PANEL
```
public static final String MAIN_PANEL
```
    Value of the parameter panel that indicates the main panel
    
    See Also:
    Constant Field Values
  - ACTION_PARAM
```
public static final String ACTION_PARAM
```
    Parameter name for the parameter indicating what action is required
    
    See Also:
    Constant Field Values
  - PAGE_NAME_PARAM
```
public static final String PAGE_NAME_PARAM
```
    Parameter name for the paramater indicating which pageName to view, edit etc.
    
    See Also:
    Constant Field Values
  - PARAM_BREADCRUMB_NAME
```
public static final String PARAM_BREADCRUMB_NAME
```
    Parameter name for the paramater indicating which pageName to view, edit etc.
    
    See Also:
    Constant Field Values
  - PAGENAME_URL_ENCODED
```
protected static final String PAGENAME_URL_ENCODED
```
  - DISBLE_BREADCRUMBS_ENCODED
```
protected static final String DISBLE_BREADCRUMBS_ENCODED
```
  - ACTION_URL_ENCODED
```
protected static final String ACTION_URL_ENCODED
```
  - PANEL_URL_ENCODED
```
protected static final String PANEL_URL_ENCODED
```
  - MAIN_URL_ENCODED
```
protected static final String MAIN_URL_ENCODED
```
  - SEARCH_URL_ENCODED
```
protected static final String SEARCH_URL_ENCODED
```
  - PAGE_URL_ENCODED
```
protected static final String PAGE_URL_ENCODED
```
  - REALM_URL_ENCODED
```
protected static final String REALM_URL_ENCODED
```
- Constructor Detail
  - ViewBean
```
public ViewBean()
```
    Simple constructor that creates an empty view bean. You must set the pageName and the localSpace to make this useful
  - ViewBean
```
public ViewBean(String name,
        String defaultSpace)
```
    Creates a ViewBean and set's the interested page name and local space
    
    Parameters:
    name - page name possibly non-globalised
    defaultSpace - default space to globalise against
- Method Detail
  - getExportUrl
```
public String getExportUrl()
```
    Returns a public view URL with no breadcrumbs
    
    Returns:
  - getPublicViewUrl
```
public String getPublicViewUrl()
```
    Returns a public view URL with no breadcrumbs
    
    Returns:
  - getPublicViewUrl
```
public String getPublicViewUrl(boolean withBreadcrumbs)
```
    Returns a string representation of an url to perma view the current page
    
    Returns:
    url as string
  - getViewUrl
```
public String getViewUrl()
```
    Returns a string representation of an url to view the current page
    
    Returns:
    url as string
  - getViewUrl
```
public String getViewUrl(String name)
```
    Returns a string representation of an url to view the passed in page
    
    Parameters:
    name - possibly non-globalised name to view
    
    Returns:
    url as string
  - getEditUrl
```
public String getEditUrl()
```
    Returns a string representation of an url to edit the current page
    
    Returns:
    url as string
  - getEditUrl
```
public String getEditUrl(String name)
```
    Returns a string representation of an url to edit the passed in page.
    
    Parameters:
    name - possibly non-globalised name
    
    Returns:
    url as string
  - getInfoUrl
```
public String getInfoUrl()
```
    Returns a string representation of an url to view information about the current page
    
    Returns:
    url as string
  - getInfoUrl
```
public String getInfoUrl(String name)
```
    Returns a string representation of an url to view information about the passed in page
    
    Parameters:
    name - possibly non-globalised name
    
    Returns:
    url as string
  - getHistoryUrl
```
public String getHistoryUrl()
```
  - getHistoryUrl
```
public String getHistoryUrl(String name)
```
  - getActionUrl
```
public String getActionUrl(WikiPageAction action)
```
    Given a WikiPageAction return an url to the current page for performing that action.
    
    Parameters:
    action - WikiPageAction to perform
    
    Returns:
    url as string
  - getActionUrl
```
public String getActionUrl(WikiPageAction action,
                  boolean breadcrumbs)
```
    Given a WikiPageAction return an url to the current page (with breadcrumbs on or off) for performing that action.
    
    Parameters:
    action - WikiPageAction to perform
    breadcrumbs - false if breadcrumbs should be disabled
    
    Returns:
    url as string
  - getActionUrl
```
public String getActionUrl(String pageName,
                  WikiPageAction action,
                  boolean breadcrumbs)
```
    Given a WikiPageAction return an url to the requested page (with breadcrumbs on or off) for performing that action.
    
    Parameters:
    action - WikiPageAction to perform
    breadcrumbs - false if breadcrumbs should be disabled
    
    Returns:
    url as string
  - getActionUrl
```
public String getActionUrl(WikiPageAction action,
                  Map parameters)
```
    Given a WikiPageAction return an url to the current page with the additional parameters being set.
    
    Parameters:
    action - WikiPageAction to perform
    parameters - Additional query parameters to attach
    
    Returns:
    url as String
  - getActionUrl
```
public String getActionUrl(String pageName,
                  WikiPageAction action,
                  Map parameters)
```
    Given a WikiPageAction return an url to the requested page with the additional parameters being set.
    
    Parameters:
    pageName - globalised pagename to perform action on
    action - WikiPageAction to perform
    parameters - Additional query parameters to attach
    
    Returns:
    url as String
  - getPageUrl
```
protected String getPageUrl(String pageName,
                String action)
```
    Given a page name and an action return an url that represents it.
    
    Parameters:
    pageName - globalised pagename to perform action on
    action - name of action to perform
    
    Returns:
    url as string
  - getPageUrl
```
protected String getPageUrl(String pageName,
                String action,
                boolean withBreadcrumbs)
```
    Given a page name and an action return an url that represents it.
    
    Parameters:
    pageName - globalised pagename to perform action on
    action - name of action to perform
    withBreadcrumbs - if false, breadcrumb disable is propagated
    
    Returns:
    url as string
  - getPageUrl
```
protected String getPageUrl(String pageName,
                String action,
                Map params)
```
  - getSearchUrl
```
protected String getSearchUrl()
```
    Creates an appropriate url for searching for the given criteria. XXX this shouldn't be here!
    
    Returns:
    url as string
  - getPageName
```
public String getPageName()
```
    The Globalised Page Name
    
    Returns:
    globalised page name
  - setPageName
```
public void setPageName(String pageName)
```
    Set the globalised page name
    
    Parameters:
    pageName - globalised page name
  - getLocalName
```
public String getLocalName()
```
    The page name localised against the localSpace
    
    Returns:
    localised page name
  - getLocalSpace
```
public String getLocalSpace()
```
    The localSpace
    
    Returns:
    localSpace as string
  - setLocalSpace
```
public void setLocalSpace(String localSpace)
```
    Set the localSpace
    
    Parameters:
    localSpace - the new localSpace
  - getPageSpace
```
public String getPageSpace()
```
    The space of that the page is in
    
    Returns:
    the page's space
  - urlEncode
```
public static String urlEncode(String toEncode)
```
    Takes a string to encode and encodes it as a UTF-8 URL-Encoded string.
    
    Parameters:
    toEncode - string to encode.
    
    Returns:
    url encoded string.
  - setAnchor
```
public void setAnchor(String anchor)
```
    Set the current anchor
    
    Parameters:
    anchor - anchor to set
  - getAnchor
```
public String getAnchor()
```
    Get the current anchor name
    
    Returns:
    anchor
  - getSearch
```
public String getSearch()
```
    The current search criteria XXX This shouldn't be here!
    
    Returns:
    search criteria
  - setSearch
```
public void setSearch(String search)
```
    Set the current search criteria XXX This shouldn't be here!
    
    Parameters:
    search - the search criteria
  - getNewCommentURL
```
public String getNewCommentURL()
```
  - getEditCommentURL
```
public String getEditCommentURL()
```
  - getListCommentsURL
```
public String getListCommentsURL()
```
  - getListPresenceURL
```
public String getListPresenceURL()
```
  - getOpenPageChatURL
```
public String getOpenPageChatURL()
```
    Returns:
  - getOpenSpaceChatURL
```
public String getOpenSpaceChatURL()
```
    Returns:
  - getListPageChatURL
```
public String getListPageChatURL()
```
    Returns:
  - getListSpaceChatURL
```
public String getListSpaceChatURL()
```
    Returns:
  - getBaseAccessUrl
```
public String getBaseAccessUrl()
```
  - getRssAccessUrl
```
public String getRssAccessUrl()
```
  - getPreferencesUrl
```
public String getPreferencesUrl()
```
  - getPrintViewUrl
```
public String getPrintViewUrl()
```
    Returns a print view URL with no breadcrumbs
    
    Returns:
  - getPrintViewUrl
```
public String getPrintViewUrl(boolean withBreadcrumbs)
```
    Returns a string representation of an url to perma view the current page
    
    Returns:
    url as string

Class ViewBean

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PANEL_PARAM

MAIN_PANEL

ACTION_PARAM

PAGE_NAME_PARAM

PARAM_BREADCRUMB_NAME

PAGENAME_URL_ENCODED

DISBLE_BREADCRUMBS_ENCODED

ACTION_URL_ENCODED

PANEL_URL_ENCODED

MAIN_URL_ENCODED

SEARCH_URL_ENCODED

PAGE_URL_ENCODED

REALM_URL_ENCODED

Constructor Detail

ViewBean

ViewBean

Method Detail

getExportUrl

getPublicViewUrl

getPublicViewUrl

getViewUrl

getViewUrl

getEditUrl

getEditUrl

getInfoUrl

getInfoUrl

getHistoryUrl

getHistoryUrl

getActionUrl

getActionUrl

getActionUrl

getActionUrl

getActionUrl

getPageUrl

getPageUrl

getPageUrl

getSearchUrl

getPageName

setPageName

getLocalName

getLocalSpace

setLocalSpace

getPageSpace

urlEncode

setAnchor

getAnchor

getSearch

setSearch

getNewCommentURL

getEditCommentURL

getListCommentsURL

getListPresenceURL

getOpenPageChatURL

getOpenSpaceChatURL

getListPageChatURL

getListSpaceChatURL

getBaseAccessUrl

getRssAccessUrl

getPreferencesUrl

getPrintViewUrl

getPrintViewUrl