|
SAP NetWeaver '04 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
com.sapportals.wcm.rendering.collection.LightCollectionRenderer
| Field Summary | |
static java.lang.String |
BASE_BUNDLE
|
static java.lang.String |
CM_RND_ACTION
|
static java.lang.String |
CM_RND_CHILDCOUNT
|
static java.lang.String |
CM_RND_CHILDCOUNT_BOTH
|
static java.lang.String |
CM_RND_CHILDCOUNT_FILES
|
static java.lang.String |
CM_RND_CHILDCOUNT_FOLDERS
|
static java.lang.String |
CM_RND_CHILDCOUNT_PROPERTY_NAME
|
static java.lang.String |
CM_RND_CHILDCOUNT_SUM
|
static java.lang.String |
CM_RND_CHILDCOUNT_WITH_BRACKETS
|
static java.lang.String |
CM_RND_CHILDCOUNT_WITH_BRACKETS_PROPERTY_NAME
|
static java.lang.String |
CM_RND_DESCRIPTION
|
static java.lang.String |
CM_RND_DISPLAYNAME
|
static java.lang.String |
CM_RND_ICON
|
static java.lang.String |
CM_RND_IMAGE
|
static java.lang.String |
CM_RND_LOCK
|
static java.lang.String |
DEFAULT_PROPERTY_COLUMNS
|
protected int |
linksForPager
|
static java.lang.String |
NBSP
|
static java.lang.String |
RES_CONTENTSOF
|
static java.lang.String |
RES_SORT_ASCENDING
|
static java.lang.String |
RES_SORT_DESCENDING
|
| Fields inherited from interface com.sapportals.wcm.rendering.collection.ICollectionRenderer |
ORDERED_COLLECTION, SORTED, UNSORTED |
| Fields inherited from interface com.sapportals.wcm.rendering.base.ILayoutObject |
DEF_VALUE, KEY, LINE_BREAK |
| Constructor Summary | |
LightCollectionRenderer()
|
|
| Method Summary | |
protected void |
createComponentValueMap()
|
java.lang.String |
createUniqueID(java.lang.String idpart)
|
protected void |
filterResourceList()
|
java.lang.Object |
get(java.lang.String key)
|
java.lang.String |
getAlias()
|
com.sapportals.wcm.rendering.collection.BundleHandler |
getBundleHandler()
|
java.lang.String |
getColumnSpacing()
|
protected ComponentValueMap |
getComponentValueMap()
|
java.lang.String |
getConfiguration(java.lang.String format)
returns the supported parameters and the default values the class uses |
protected int |
getElementsPerPage()
|
com.sapportals.wcm.repository.service.layout.customizing.flavor.IFlavor |
getFlavor()
|
java.lang.String |
getID()
|
protected int |
getIntValue(com.sapportals.wcm.repository.service.layout.customizing.IParameterName key,
int defValue)
|
protected int |
getIntValue(java.lang.String key,
int defValue)
|
protected IRendererStatus |
getIRS()
|
protected LayoutObject |
getLayoutObject()
|
java.util.List |
getMultiValueParameter(com.sapportals.wcm.repository.service.layout.customizing.IParameterName key)
|
java.lang.String |
getParameter(com.sapportals.wcm.repository.service.layout.customizing.IParameterName key)
|
boolean |
getParameter(com.sapportals.wcm.repository.service.layout.customizing.IParameterName key,
boolean defaultValue)
|
int |
getParameter(com.sapportals.wcm.repository.service.layout.customizing.IParameterName key,
int defaultValue)
|
java.lang.String |
getParameter(com.sapportals.wcm.repository.service.layout.customizing.IParameterName key,
java.lang.String defaultValue)
|
com.sapportals.htmlb.enum.TextViewDesign |
getParameter(com.sapportals.wcm.repository.service.layout.customizing.IParameterName key,
com.sapportals.htmlb.enum.TextViewDesign defaultValue)
|
com.sapportals.wcm.repository.service.layout.customizing.IParameters |
getParameters()
returns all parameters used in this layout object. |
com.sapportals.wcm.repository.service.layout.customizing.IParameters |
getParameters(com.sapportals.wcm.repository.service.layout.customizing.IParameterName[] keys)
|
ICollection |
getParentCollection()
|
IPropertyNameList |
getPropertyNames()
|
protected IProxy |
getProxy()
|
protected IResourceRenderer |
getRenderer(IResource res)
|
IResourceContext |
getResourceContext()
|
protected IResourceList |
getResourceList()
|
protected com.sapportals.wcm.rendering.collection.LightCollectionRenderer.RenderInformationCollector |
getRIC()
|
java.lang.String |
getRowSpacing()
|
IResourceList |
getSelectedResources()
|
int |
getStartRow()
|
com.sapportals.wcm.repository.service.layout.customizing.IParameterName[] |
getSupportedParameters()
returns all parameters which are used in this layout object. |
protected ITypedResourceList |
getTypedResourceList()
|
protected ICollectionRenderer |
initNewInstance(ICollectionRenderer cr)
|
boolean |
is508enabled()
|
boolean |
isExactlyValue(com.sapportals.wcm.repository.service.layout.customizing.IParameterName key,
java.lang.Object checkValue)
|
boolean |
isNoOtherValue(com.sapportals.wcm.repository.service.layout.customizing.IParameterName key,
java.lang.Object checkValue)
|
boolean |
isVisible()
|
IRenderingEvent |
onEvent(com.sapportals.htmlb.event.Event event)
|
com.sapportals.wcm.rendering.collection.IParameterNameSet |
parameterNames()
|
java.util.Set |
parameters()
|
void |
readInputData(com.sapportals.htmlb.page.DynPage page)
reads out the input of the modifiable Components rendered by
the implementing class. |
void |
refresh()
asks the implementing class to refresh its list of IResource objects.
|
void |
removeParameter(com.sapportals.wcm.repository.service.layout.customizing.IParameterName key)
|
com.sapportals.htmlb.Component |
renderAll()
|
protected com.sapportals.htmlb.Component |
renderBreadcrumb()
|
protected com.sapportals.htmlb.Component |
renderDecorations(com.sapportals.htmlb.Component comp)
|
com.sapportals.htmlb.Component |
renderFolderTitle()
|
com.sapportals.htmlb.Component |
renderItemSelectionMode(IResource res)
|
protected com.sapportals.htmlb.Component |
renderPager(boolean hasMore,
int pageInterval,
int linkCount)
creates a new instance of a Pager and returns its results of the
render method. |
protected com.sapportals.htmlb.Component |
renderSearchHeader()
|
protected com.sapportals.htmlb.Component |
renderUI()
|
void |
resetSelection()
clears the list of selected resources |
void |
set508enabled(boolean value)
|
void |
setAlias(java.lang.String alias)
|
void |
setFlavor(com.sapportals.wcm.repository.service.layout.customizing.flavor.IFlavor impFlavor)
is called from the factory after instantiating a new layout object to set the flavor information coming from the Control or ILayoutController ,
asking for special instances of the IResourceRenderer used by the implementing class |
java.lang.Boolean |
setParameter(com.sapportals.wcm.repository.service.layout.customizing.IParameterName key,
boolean value)
|
java.lang.Integer |
setParameter(com.sapportals.wcm.repository.service.layout.customizing.IParameterName key,
int value)
|
java.lang.Object |
setParameter(com.sapportals.wcm.repository.service.layout.customizing.IParameterName key,
java.lang.Object value)
|
java.lang.String |
setParameter(com.sapportals.wcm.repository.service.layout.customizing.IParameterName key,
java.lang.String value)
|
com.sapportals.htmlb.enum.TextViewDesign |
setParameter(com.sapportals.wcm.repository.service.layout.customizing.IParameterName key,
com.sapportals.htmlb.enum.TextViewDesign value)
|
void |
setParameters(com.sapportals.wcm.repository.service.layout.customizing.IParameters parameters)
is called from the factory after initializing this layout object. |
void |
setParentCollection(ICollection parent)
is called from the factory after instantiating a new collection renderer to set the collection which has to be rendered. |
void |
setPropertyNames(IPropertyNameList nameList)
|
void |
setProxy(IProxy proxy)
it is the renderers responsibility to make itself known to the proxy. |
void |
setResourceContext(IResourceContext context)
sets the context-attribute for the renderer. |
void |
setSortDefinition(SortDefinition sd)
sets the sort-definition attribute for the implementing class. |
void |
setStartRow(int value)
|
void |
setSupportedParameters(com.sapportals.wcm.repository.service.layout.customizing.IParameterName[] impKeys)
|
void |
setTypedResourceList(ITypedResourceList typedresourcelist)
is called from the factory after instantiating a new collection renderer to set the resourceList which has to be rendered. |
protected void |
sortResourceList(IPropertyNameList list,
SortDefinition sd)
|
protected void |
writeDebugInformation()
|
| Methods inherited from interface com.sapportals.wcm.rendering.base.ILayoutObject |
getNewInstance |
| Field Detail |
public static final java.lang.String NBSP
public static final java.lang.String RES_SORT_ASCENDING
public static final java.lang.String RES_SORT_DESCENDING
public static final java.lang.String RES_CONTENTSOF
public static final java.lang.String BASE_BUNDLE
public static final java.lang.String CM_RND_ACTION
public static final java.lang.String CM_RND_DISPLAYNAME
public static final java.lang.String CM_RND_ICON
public static final java.lang.String CM_RND_IMAGE
public static final java.lang.String CM_RND_DESCRIPTION
public static final java.lang.String CM_RND_LOCK
public static final java.lang.String CM_RND_CHILDCOUNT
public static final java.lang.String CM_RND_CHILDCOUNT_WITH_BRACKETS
public static final java.lang.String CM_RND_CHILDCOUNT_BOTH
public static final java.lang.String CM_RND_CHILDCOUNT_SUM
public static final java.lang.String CM_RND_CHILDCOUNT_FOLDERS
public static final java.lang.String CM_RND_CHILDCOUNT_FILES
public static final java.lang.String CM_RND_CHILDCOUNT_PROPERTY_NAME
public static final java.lang.String CM_RND_CHILDCOUNT_WITH_BRACKETS_PROPERTY_NAME
public static final java.lang.String DEFAULT_PROPERTY_COLUMNS
protected int linksForPager
| Constructor Detail |
public LightCollectionRenderer()
| Method Detail |
protected com.sapportals.wcm.rendering.collection.LightCollectionRenderer.RenderInformationCollector getRIC()
protected final ICollectionRenderer initNewInstance(ICollectionRenderer cr)
public final java.lang.String getAlias()
getAlias in interface ILayoutObjectpublic final void setAlias(java.lang.String alias)
setAlias in interface ILayoutObjectpublic final void setFlavor(com.sapportals.wcm.repository.service.layout.customizing.flavor.IFlavor impFlavor)
ILayoutObjectControl or ILayoutController ,
asking for special instances of the IResourceRenderer used by the implementing classsetFlavor in interface ILayoutObjectpublic final com.sapportals.wcm.repository.service.layout.customizing.flavor.IFlavor getFlavor()
getFlavor in interface ILayoutObjectcom.sapportals.wcm.rendering.base.ILayoutObjectpublic boolean is508enabled()
is508enabled in interface ILayoutObjectcom.sapportals.wcm.rendering.base.ILayoutObjectpublic void set508enabled(boolean value)
public final void setSupportedParameters(com.sapportals.wcm.repository.service.layout.customizing.IParameterName[] impKeys)
public com.sapportals.wcm.repository.service.layout.customizing.IParameterName[] getSupportedParameters()
ILayoutObjectgetSupportedParameters in interface ILayoutObjectcom.sapportals.wcm.rendering.base.ILayoutObjectILayoutObject.setParameters(com.sapportals.wcm.repository.service.layout.customizing.IParameters)public final java.lang.String getConfiguration(java.lang.String format)
ILayoutObjectgetConfiguration in interface ILayoutObjectpublic java.lang.String getParameter(com.sapportals.wcm.repository.service.layout.customizing.IParameterName key)
getParameter in interface ILayoutObjectcom.sapportals.wcm.rendering.base.ILayoutObjectnull. Note: a
returned null does not indicate, that the ILayoutObject
does not support this parameter!public com.sapportals.wcm.repository.service.layout.customizing.IParameters getParameters()
ILayoutObjectgetParameters in interface ILayoutObjectcom.sapportals.wcm.rendering.base.ILayoutObject
public java.lang.String setParameter(com.sapportals.wcm.repository.service.layout.customizing.IParameterName key,
java.lang.String value)
setParameter in interface ILayoutObjectcom.sapportals.wcm.rendering.base.ILayoutObjectkey - - the key of the parametervalue - - the value of the parameter
Overwrites an existing entry of the parameters or adds it, if it is not set.
Note: The Layout Object may not act on this parameter. To retrieve a list
of supported parameters from an ILayoutObject instancepublic void setParameters(com.sapportals.wcm.repository.service.layout.customizing.IParameters parameters)
ILayoutObject IParameterName[] getSupportedParameters()
are set by the factory.
With this method the rendering of the implementing class can be influenced. Classes
can - but do not have to - react on the parameters supplied in this methodsetParameters in interface ILayoutObjectcom.sapportals.wcm.rendering.base.ILayoutObjectparameters - - the parameters retrieved from different sources (iView, OTH...)
that influence the way the implementing class renders its output. If the parameter is not found in the
class' getSupportedParameters, the value will not be set as parameter for this class.
If for a certain key, no value is found in the given IParameters, the default value set in the class will
not be overwritten.
Example:
The class returns as supported parameters the keys "A", "B".
It has set the default parameters, so we find the key-value pairs:
"A" -> a
"B" -> b
This method is called, with the following hashtable entries:
"A" -> aa
"C" -> cc
After the method is called, the class holds following key-vlaue pairs:
"A" -> aa (overwritten by passed hashtable values)
"B" -> b (not overwritten, because the hashtable returned null for this key
The key-value pair "C" -> cc is not used in the class, because the key was not found in its
getSupportedParameterspublic final void setProxy(IProxy proxy)
IRendererStatus
object within the proxy. When problems with persistence (lost selected resources
or exception when reading out the user input) occur, this method and getIRS()
should be closely evaluated.setProxy in interface ILayoutObjectproxy - The new proxy valueprotected final IProxy getProxy()
public final boolean isExactlyValue(com.sapportals.wcm.repository.service.layout.customizing.IParameterName key,
java.lang.Object checkValue)
public final boolean isNoOtherValue(com.sapportals.wcm.repository.service.layout.customizing.IParameterName key,
java.lang.Object checkValue)
public final com.sapportals.htmlb.enum.TextViewDesign getParameter(com.sapportals.wcm.repository.service.layout.customizing.IParameterName key,
com.sapportals.htmlb.enum.TextViewDesign defaultValue)
public final java.lang.String getParameter(com.sapportals.wcm.repository.service.layout.customizing.IParameterName key,
java.lang.String defaultValue)
public final int getParameter(com.sapportals.wcm.repository.service.layout.customizing.IParameterName key,
int defaultValue)
public final boolean getParameter(com.sapportals.wcm.repository.service.layout.customizing.IParameterName key,
boolean defaultValue)
public final java.util.List getMultiValueParameter(com.sapportals.wcm.repository.service.layout.customizing.IParameterName key)
public com.sapportals.wcm.repository.service.layout.customizing.IParameters getParameters(com.sapportals.wcm.repository.service.layout.customizing.IParameterName[] keys)
public final java.util.Set parameters()
public final com.sapportals.wcm.rendering.collection.IParameterNameSet parameterNames()
public final java.lang.Object get(java.lang.String key)
public void removeParameter(com.sapportals.wcm.repository.service.layout.customizing.IParameterName key)
public final java.lang.Boolean setParameter(com.sapportals.wcm.repository.service.layout.customizing.IParameterName key,
boolean value)
public final java.lang.Integer setParameter(com.sapportals.wcm.repository.service.layout.customizing.IParameterName key,
int value)
public final com.sapportals.htmlb.enum.TextViewDesign setParameter(com.sapportals.wcm.repository.service.layout.customizing.IParameterName key,
com.sapportals.htmlb.enum.TextViewDesign value)
public final java.lang.Object setParameter(com.sapportals.wcm.repository.service.layout.customizing.IParameterName key,
java.lang.Object value)
protected final int getIntValue(java.lang.String key,
int defValue)
protected final int getIntValue(com.sapportals.wcm.repository.service.layout.customizing.IParameterName key,
int defValue)
public final void setStartRow(int value)
throws WcmException
public final int getStartRow()
throws WcmException
public final IPropertyNameList getPropertyNames()
public void setPropertyNames(IPropertyNameList nameList)
protected LayoutObject getLayoutObject()
public java.lang.String getColumnSpacing()
public java.lang.String getRowSpacing()
protected final com.sapportals.htmlb.Component renderPager(boolean hasMore,
int pageInterval,
int linkCount)
throws WcmException
Pager and returns its results of the
render method. The current IProxy object of the renderer
is used as target for any Events created by the pager. The pager
class is used again in the onEvent method of the renderer.hasMore - Description of the ParameterpageInterval - Description of the ParameterlinkCount - Description of the ParameterWcmException - Description of the Exception
protected final com.sapportals.htmlb.Component renderSearchHeader()
throws WcmException
public com.sapportals.htmlb.Component renderFolderTitle()
throws WcmException
protected final com.sapportals.htmlb.Component renderBreadcrumb()
throws WcmException
WcmException - Description of the Exception
public final com.sapportals.htmlb.Component renderItemSelectionMode(IResource res)
throws WcmException
protected final void writeDebugInformation()
public void setParentCollection(ICollection parent)
ICollectionRenderersetTypedResourceList(ITypedResourceList resourcelist)
method is called, i.e. when a search result has to be rendered.setParentCollection in interface ICollectionRenderercom.sapportals.wcm.rendering.collection.ICollectionRenderercollection - the collection to render (and whose chidren to render)public final void setTypedResourceList(ITypedResourceList typedresourcelist)
ICollectionRenderersetParentCollection(ICollection collection)
method is called, i.e. when a folder has to be renderedsetTypedResourceList in interface ICollectionRenderercom.sapportals.wcm.rendering.collection.ICollectionRendererresourcelist - the resourcelist to render (and whose members to render)
protected final IResourceRenderer getRenderer(IResource res)
throws WcmException
public ICollection getParentCollection()
protected ITypedResourceList getTypedResourceList()
public com.sapportals.htmlb.Component renderAll()
throws WcmException
renderAll in interface ICollectionRenderercom.sapportals.wcm.rendering.collection.ICollectionRenderer
protected com.sapportals.htmlb.Component renderDecorations(com.sapportals.htmlb.Component comp)
throws WcmException
protected void createComponentValueMap()
throws WcmException
protected ComponentValueMap getComponentValueMap()
throws WcmException
protected int getElementsPerPage()
protected com.sapportals.htmlb.Component renderUI()
throws WcmException
protected final void filterResourceList()
throws WcmException
public void refresh()
ICollectionRendererIResource objects.
This is needed, if a list that is displayed by this is modified after this
has created its internal representation of these resources. This call is only
useful, if the setParentCollection or setTypedResourceList
method has been invoked in advance.
This method can be very expensive, depending on the size of the resource list
and the ordering and filtering calls that have to be carried out. In a
standard scenario, this call is not needed, as the IProxyControl
will refresh automatically all resource-list representations that use the proxy as
persistence-layer. Implementations such as the AbstractCollectionRenderer
may not react on this method at all, as they do not persist their resource list
representations and therefore always have an up-to-date representation.refresh in interface ICollectionRenderer
protected IRendererStatus getIRS()
throws WcmException
public java.lang.String createUniqueID(java.lang.String idpart)
public void readInputData(com.sapportals.htmlb.page.DynPage page)
throws WcmException
ICollectionRendererComponents rendered by
the implementing class.readInputData in interface ICollectionRendererpublic java.lang.String getID()
getID in interface ICollectionRenderercom.sapportals.wcm.rendering.collection.ICollectionRendererIProxy's method register. This ID will be stable
over http-requests.public void setResourceContext(IResourceContext context)
ICollectionRenderernullsetResourceContext in interface ICollectionRendererpublic IResourceContext getResourceContext()
getResourceContext in interface ICollectionRenderercom.sapportals.wcm.rendering.collection.ICollectionRenderernullpublic com.sapportals.wcm.rendering.collection.BundleHandler getBundleHandler()
public IRenderingEvent onEvent(com.sapportals.htmlb.event.Event event)
throws WcmException
onEvent in interface IDelegatedReceiverpublic void setSortDefinition(SortDefinition sd)
ICollectionRenderersetSortDefinition in interface ICollectionRendererpublic final IResourceList getSelectedResources()
getSelectedResources in interface IResourceListProvidercom.sapportals.wcm.rendering.base.IResourceListProvidernullpublic void resetSelection()
IResourceListProviderresetSelection in interface IResourceListProvider
protected IResourceList getResourceList()
throws WcmException
protected final void sortResourceList(IPropertyNameList list,
SortDefinition sd)
throws WcmException
public boolean isVisible()
|
SAP NetWeaver '04 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||