|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.struts.action.ActionForm
com.actuate.activeportal.forms.BaseActionForm
com.actuate.activeportal.forms.GeneralFilterActionForm
com.actuate.activeportal.forms.FileListActionForm
public class FileListActionForm
This form is used for retrieving the list of files that are displayed in the file list. The form manages setting of filters and after the query is executed on the server the action updates this form with the list of objects retrieved from the server.
Constructor Summary | |
---|---|
FileListActionForm()
|
Method Summary | |
---|---|
void |
addCategory(java.lang.String _categoryName,
java.util.Collection items)
This method is called by the action to add all items belonging to a particular category into the form. |
void |
fixUTF8()
This method is called to convert the data submitted by the browser to a java string value. |
java.lang.Object[] |
getArray(java.lang.String _categoryName)
This method should return the list of objects whose properties are to be displayed. |
java.lang.String[] |
getCategories()
This method is used by the categories view to retrieve the list of categories it is supposed to display. |
java.util.Collection |
getCollection(java.lang.String _categoryName)
This method should return the list of objects whose properties are to be displayed. |
java.lang.String |
getFolderId()
Returns the id of the folder that is currently being displayed if available |
java.lang.String |
getFolderName()
Returns the name of the folder whose contents are currently being displayed. |
java.util.Collection |
getFolders()
Returns the list of folders that have been set by calling the setFolders method |
boolean |
isEmpty()
This method is called by the views to determine whether the list is empty. |
boolean |
isShowLatestQueries()
Returns a boolean indicating whether only the latest information objects are supposed to be displayed. |
void |
setAllItems(java.lang.Object[] items)
In case the view is not a categorized view, this method is called by the action to keep all the items in one single array. |
void |
setFolderId(java.lang.String string)
Called to set the id of the folder that is currently being displayed. |
void |
setFolderName(java.lang.String string)
Called to set the name of the folder whose contents are currently being displayed. |
void |
setFolders(java.util.Collection c)
This method is called in case of the tree view skin since it always needs the folder list for the left frame irrespective of the filter applied on the content frame. |
void |
setShowLatestQueries(boolean b)
If this is set to true then only the latest information objects will be shown. |
Methods inherited from class com.actuate.activeportal.forms.GeneralFilterActionForm |
---|
getCompletedFilter, getFilter, getPendingFilter, getRunningFilter, getScheduledFilter, getWaitingFilter, isApplyFilter, isCbFail, isCbSuccess, isFilterEnabled, isOnlyLatest, isResetFilter, isShowDocuments, isShowExecutables, isShowFolders, reset, setApplyFilter, setCbFail, setCbSuccess, setCompletedFilter, setFilter, setFilterEnabled, setOnlyLatest, setPendingFilter, setResetFilter, setRunningFilter, setScheduledFilter, setShowDocuments, setShowExecutables, setShowFolders, setWaitingFilter |
Methods inherited from class com.actuate.activeportal.forms.BaseActionForm |
---|
isPostback, setPostback |
Methods inherited from class org.apache.struts.action.ActionForm |
---|
getMultipartRequestHandler, getServletWrapper, reset, setMultipartRequestHandler, setServlet, validate, validate |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public FileListActionForm()
Method Detail |
---|
public java.lang.String[] getCategories()
IContentList
This method is used by the categories view to retrieve the list of categories it is supposed to display.
For e.g.
The file list implementation will return
{folders}
{documents}
{executables}
etc....
getCategories
in interface IContentList
IContentList.getCategories()
public java.lang.Object[] getArray(java.lang.String _categoryName)
IContentList
This method should return the list of objects whose properties are to be displayed.
For e.g.
If the file list is being displayed then each object in the array will be an
instance of com.actuate.schemas.File
If this method returns null then the getCollection() method will be called.
This method is called with the category name as a parameter.
Bear in mind that this can be null if the view is not the category view; in such a case
the entire list should normally be returned.
getArray
in interface IContentList
_categoryName
- The category which is being displayed currently
IContentList.getArray(java.lang.String)
public java.util.Collection getCollection(java.lang.String _categoryName)
IContentList
This method should return the list of objects whose properties are to be displayed.
For e.g. If the file list is being displayed then each object in the array will be an instance of com.actuate.schemas.File If this method returns null then the getCollection() method will be called. This method is called with the category name as a parameter. Bear in mind that this can be null if the view is not the category view; in such a case the entire list should normally be returned.
getCollection
in interface IContentList
_categoryName
- The category which is being displayed currently
IContentList.getCollection(java.lang.String)
public boolean isEmpty()
IContentList
isEmpty
in interface IContentList
IContentList.isEmpty()
public void addCategory(java.lang.String _categoryName, java.util.Collection items)
_categoryName
- The name of the category to be addeditems
- The list of items belonging to the category.public void setAllItems(java.lang.Object[] items)
items
- All the list of files that have been retrieved by the actionpublic java.util.Collection getFolders()
setFolders
method
public void setFolders(java.util.Collection c)
c
- A collection containing the list of folderspublic java.lang.String getFolderId()
public java.lang.String getFolderName()
public void setFolderId(java.lang.String string)
string
- The id of the folder.public void setFolderName(java.lang.String string)
string
- The name of the folderpublic void fixUTF8()
fixUTF8
in class BaseActionForm
public boolean isShowLatestQueries()
public void setShowLatestQueries(boolean b)
b
- A boolean indicating whether the latest versions of queries should be shown or all versions should be shown
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |