com.atlassian.jira.web.action
Class AbstractBrowser

java.lang.Object
  extended bywebwork.action.ActionSupport
      extended bycom.atlassian.jira.action.JiraActionSupport
          extended bycom.atlassian.jira.web.action.JiraWebActionSupport
              extended bycom.atlassian.jira.web.action.ProjectActionSupport
                  extended bycom.atlassian.jira.web.action.IssueActionSupport
                      extended bycom.atlassian.jira.web.action.AbstractBrowser
All Implemented Interfaces:
webwork.action.Action, webwork.action.CommandDriven, ErrorCollection, I18nHelper, webwork.action.IllegalArgumentAware, webwork.action.ParameterAware, java.io.Serializable
Direct Known Subclasses:
GroupBrowser, IssueNavigator, UserBrowser, UserPickerBrowser

public abstract class AbstractBrowser
extends IssueActionSupport
implements webwork.action.ParameterAware

An abstract browser that implements a few helpful things for paging.

See Also:
Serialized Form

Field Summary
(package private) static java.lang.String[] maxValues
           
static java.lang.String MODE_HIDE
           
static java.lang.String MODE_SHOW
           
protected  java.util.Map params
           
 
Fields inherited from class com.atlassian.jira.web.action.IssueActionSupport
attachmentManager
 
Fields inherited from class com.atlassian.jira.web.action.ProjectActionSupport
projectManager, savedFilters
 
Fields inherited from class com.atlassian.jira.web.action.JiraWebActionSupport
ISSUE_NOT_FOUND_RESULT, PERMISSION_VIOLATION_RESULT, request
 
Fields inherited from class com.atlassian.jira.action.JiraActionSupport
log
 
Fields inherited from class webwork.action.ActionSupport
command, errorMap, errorMessages
 
Fields inherited from interface com.atlassian.jira.util.I18nHelper
DEFAULT_RESOURCE_BUNDLE
 
Fields inherited from interface webwork.action.Action
ERROR, INPUT, LOGIN, NONE, SUCCESS
 
Constructor Summary
AbstractBrowser()
           
 
Method Summary
abstract  java.util.Collection getBrowsableItems()
           
abstract  java.util.Collection getCurrentPage()
          Return the current 'page' of items (given max and start) for the current filter
 java.lang.String[] getMaxValues()
          The different preset values that max can take

Used by forms to display a select box of max items per page

 java.lang.String getMode()
           
 int getNiceEnd()
          Return the 'readable' end
 int getNiceStart()
          Return the 'readable' start (ie 1 instead of 0)
abstract  PagerFilter getPager()
           
protected  java.lang.String getSingleParam(java.lang.String s)
           
 java.util.Collection getTimePeriods()
           
abstract  void resetPager()
           
 void setHide(java.lang.String value)
           
 void setMode(java.lang.String mode)
          Control the mode (hide or show) of the left hand column
 void setParameters(java.util.Map parameters)
           
 void setShow(java.lang.String value)
           
 void setStart(java.lang.String start)
           
 
Methods inherited from class com.atlassian.jira.web.action.IssueActionSupport
getActionManager, getAttachmentManager, getCustomFieldManager, getDaysPerWeek, getHoursPerDay, getIssueManager, getPossibleVersions, getPossibleVersionsReleasedFirst, getPrettyDuration, getSearchRequest, getUrlEncoded, getWorkflow, isCustomFieldHidden, isFieldHidden, isFieldHidden, isFieldHidden, setCurrentIssue
 
Methods inherited from class com.atlassian.jira.web.action.ProjectActionSupport
getBrowseableProjects, getBrowseableProjectsInCategory, getSavedFilters, getSelectedProject, isEnterprise, setSelectedProject, setSelectedProjectId
 
Methods inherited from class com.atlassian.jira.web.action.JiraWebActionSupport
addErrorCollection, getAssignableUsers, getAssignableUsers, getCachedGroups, getColumnViewHtml, getComponentManager, getConstantsManager, getCustomFieldHtml, getCustomFieldXML, getDefaultAssignee, getDefaultResourceBundle, getField, getLocale, getOutlookDate, getPermissionManager, getProjectManager, getPropertySet, getRedirect, getRemoteUser, getReturnUrl, getText, getText, getText, getText, getText, getUserFullName, getUserPreferences, getVersionManager, isDefaultAssignee, isDefaultAssignee, isHasIssuePermission, isHasIssuePermission, isHasPermission, isHasPermission, isHasPermission, isHasProjectPermission, isHasProjectPermission, processDefaultAssignee, processDefaultAssignee, processDefaultAssignee, setReturnUrl
 
Methods inherited from class com.atlassian.jira.action.JiraActionSupport
addErrorMessages, addErrorMessages, addErrors, execute, getActionName, getApplicationProperties, getDelegator, getLocaleUtils, getResult, getUnescapedText, getWatcherManager, hasAnyErrors, isIndexing
 
Methods inherited from class webwork.action.ActionSupport
addError, addErrorMessage, addIllegalArgumentException, doDefault, doExecute, doValidation, getErrorMessages, getErrors, getHasErrorMessages, getHasErrors, getPropertyEditorMessage, getTexts, getTexts, invalidInput, invokeCommand, isCommand, setCommand, setErrorMessages, setErrors, validate
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.atlassian.jira.util.ErrorCollection
addError, addErrorMessage, addErrorMessages, addErrors, getErrorMessages, getErrors, hasAnyErrors
 
Methods inherited from interface webwork.action.CommandDriven
setCommand
 

Field Detail

maxValues

static java.lang.String[] maxValues

params

protected java.util.Map params

MODE_SHOW

public static final java.lang.String MODE_SHOW
See Also:
Constant Field Values

MODE_HIDE

public static final java.lang.String MODE_HIDE
See Also:
Constant Field Values
Constructor Detail

AbstractBrowser

public AbstractBrowser()
Method Detail

getCurrentPage

public abstract java.util.Collection getCurrentPage()
Return the current 'page' of items (given max and start) for the current filter


getBrowsableItems

public abstract java.util.Collection getBrowsableItems()

getPager

public abstract PagerFilter getPager()

resetPager

public abstract void resetPager()

setParameters

public void setParameters(java.util.Map parameters)
Specified by:
setParameters in interface webwork.action.ParameterAware

getSingleParam

protected java.lang.String getSingleParam(java.lang.String s)

setStart

public void setStart(java.lang.String start)

getNiceStart

public int getNiceStart()
Return the 'readable' start (ie 1 instead of 0)


getNiceEnd

public int getNiceEnd()
Return the 'readable' end


getMode

public java.lang.String getMode()

setMode

public void setMode(java.lang.String mode)
Control the mode (hide or show) of the left hand column


setHide

public void setHide(java.lang.String value)

setShow

public void setShow(java.lang.String value)

getMaxValues

public java.lang.String[] getMaxValues()
The different preset values that max can take

Used by forms to display a select box of max items per page


getTimePeriods

public java.util.Collection getTimePeriods()


Copyright © 2002-2005 Atlassian. All Rights Reserved.