|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opencms.workplace.list.CmsListResourcesCollector
Collector for receiving CmsResource
from a A_CmsListExplorerDialog
.
Field Summary | |
static java.lang.String |
LIST_COLLECTOR_NAME
Parameter of the default collector name. |
Constructor Summary | |
CmsListResourcesCollector(java.util.List resources)
Constructor, creates a new CmsListResourcesCollector . |
Method Summary | |
int |
compareTo(java.lang.Object arg0)
|
java.util.List |
getCollectorNames()
Returns a list of all collector names (Strings) this collector implementation supports. |
java.lang.String |
getCreateLink(CmsObject cms)
Returns the link that must be executed when a user clicks on the direct edit "new" button on a list created by the default collector. |
java.lang.String |
getCreateLink(CmsObject cms,
java.lang.String collectorName,
java.lang.String param)
Returns the link that must be executed when a user clicks on the direct edit "new" button on a list created by the named collector. |
java.lang.String |
getCreateParam(CmsObject cms)
Returns the default parameter that must be passed to the getCreateLink(CmsObject, String, String) method. |
java.lang.String |
getCreateParam(CmsObject cms,
java.lang.String collectorName,
java.lang.String param)
Returns the parameter that must be passed to the getCreateLink(CmsObject, String, String) method. |
java.lang.String |
getDefaultCollectorName()
Returns the default collector name to use for collecting resources. |
java.lang.String |
getDefaultCollectorParam()
Returns the default collector parameter to use for collecting resources. |
int |
getOrder()
Returns the "order weight" of this collector. |
java.util.List |
getResults(CmsObject cms)
Returns a list of CmsResource Objects that are
gathered in the VFS using the default collector name and parameter. |
java.util.List |
getResults(CmsObject cms,
java.lang.String collectorName,
java.lang.String param)
Returns a list of CmsResource Objects that are
gathered in the VFS using the named collector. |
void |
setDefaultCollectorName(java.lang.String collectorName)
Sets the default collector name to use for collecting resources. |
void |
setDefaultCollectorParam(java.lang.String param)
Sets the default collector parameter to use for collecting resources. |
void |
setOrder(int order)
Sets the "order weight" of this collector. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final java.lang.String LIST_COLLECTOR_NAME
Constructor Detail |
public CmsListResourcesCollector(java.util.List resources)
CmsListResourcesCollector
.
resources
- a list of CmsResource
objects.Method Detail |
public int compareTo(java.lang.Object arg0)
compareTo
in interface java.lang.Comparable
Comparable.compareTo(java.lang.Object)
public java.util.List getCollectorNames()
I_CmsResourceCollector
getCollectorNames
in interface I_CmsResourceCollector
I_CmsResourceCollector.getCollectorNames()
public java.lang.String getCreateLink(CmsObject cms)
I_CmsResourceCollector
If this method returns null
,
it indicated that the selected collector implementation does not support a "create link",
and so no "new" button will should shown on lists generated with this collector.
getCreateLink
in interface I_CmsResourceCollector
cms
- the current CmsObject
I_CmsResourceCollector.getCreateLink(org.opencms.file.CmsObject)
public java.lang.String getCreateLink(CmsObject cms, java.lang.String collectorName, java.lang.String param)
I_CmsResourceCollector
If this method returns null
,
it indicated that the selected collector implementation does not support a "create link",
and so no "new" button will should shown on lists generated with this collector.
getCreateLink
in interface I_CmsResourceCollector
cms
- the current CmsObjectcollectorName
- the name of the collector to useparam
- an optional collector parameter
I_CmsResourceCollector.getCreateLink(org.opencms.file.CmsObject, java.lang.String, java.lang.String)
public java.lang.String getCreateParam(CmsObject cms)
I_CmsResourceCollector
I_CmsResourceCollector.getCreateLink(CmsObject, String, String)
method.
If this method returns null
,
it indicates that the selected collector implementation does not support a "create link",
and so no "new" button will should shown on lists generated with this collector.
getCreateParam
in interface I_CmsResourceCollector
cms
- the current CmsObject
I_CmsResourceCollector.getCreateLink(CmsObject, String, String)
method, or nullI_CmsResourceCollector.getCreateParam(org.opencms.file.CmsObject)
public java.lang.String getCreateParam(CmsObject cms, java.lang.String collectorName, java.lang.String param)
I_CmsResourceCollector
I_CmsResourceCollector.getCreateLink(CmsObject, String, String)
method.
If this method returns null
,
it indicates that the selected collector implementation does not support a "create link",
and so no "new" button will should shown on lists generated with this collector.
getCreateParam
in interface I_CmsResourceCollector
cms
- the current CmsObjectcollectorName
- the name of the collector to useparam
- an optional collector parameter from the current page context
I_CmsResourceCollector.getCreateLink(CmsObject, String, String)
method, or nullI_CmsResourceCollector.getCreateParam(org.opencms.file.CmsObject, java.lang.String, java.lang.String)
public java.lang.String getDefaultCollectorName()
I_CmsResourceCollector
getDefaultCollectorName
in interface I_CmsResourceCollector
I_CmsResourceCollector.getDefaultCollectorName()
public java.lang.String getDefaultCollectorParam()
I_CmsResourceCollector
getDefaultCollectorParam
in interface I_CmsResourceCollector
I_CmsResourceCollector.getDefaultCollectorParam()
public int getOrder()
I_CmsResourceCollector
The "order weight" is important because two collector classes may provide a collector with the same name. If this is the case, the collector implementation with the higher order number "overrules" the lower order number classs.
getOrder
in interface I_CmsResourceCollector
I_CmsResourceCollector.getOrder()
public java.util.List getResults(CmsObject cms)
I_CmsResourceCollector
CmsResource
Objects that are
gathered in the VFS using the default collector name and parameter.
getResults
in interface I_CmsResourceCollector
cms
- the current CmsObject
I_CmsResourceCollector.getResults(org.opencms.file.CmsObject)
public java.util.List getResults(CmsObject cms, java.lang.String collectorName, java.lang.String param)
I_CmsResourceCollector
CmsResource
Objects that are
gathered in the VFS using the named collector.
getResults
in interface I_CmsResourceCollector
cms
- the current CmsObjectcollectorName
- the name of the collector to useparam
- an optional collector parameter
I_CmsResourceCollector.getResults(org.opencms.file.CmsObject, java.lang.String, java.lang.String)
public void setDefaultCollectorName(java.lang.String collectorName)
I_CmsResourceCollector
setDefaultCollectorName
in interface I_CmsResourceCollector
collectorName
- the default collector nameI_CmsResourceCollector.setDefaultCollectorName(java.lang.String)
public void setDefaultCollectorParam(java.lang.String param)
I_CmsResourceCollector
setDefaultCollectorParam
in interface I_CmsResourceCollector
param
- the default collector parameterI_CmsResourceCollector.setDefaultCollectorParam(java.lang.String)
public void setOrder(int order)
I_CmsResourceCollector
setOrder
in interface I_CmsResourceCollector
order
- the order weight to setI_CmsResourceCollector.setOrder(int)
|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |