|
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opencms.jsp.CmsJspNavElement
public class CmsJspNavElement
Bean to collect navigation information from a resource in the OpenCms VFS.
Each nav element contains a number of information about a VFS resource, obtained either from the resources properties or attributes. You can use this information to generate a HTML navigation for files in the VFS in your template.
CmsJspNavBuilder
Constructor Summary | |
---|---|
CmsJspNavElement()
Empty constructor required for every JavaBean, does nothing. |
|
CmsJspNavElement(java.lang.String resource,
java.util.Map properties)
Create a new instance of the bean and calls the init method with the provided parametes. |
|
CmsJspNavElement(java.lang.String resource,
java.util.Map properties,
int navTreeLevel)
Create a new instance of the bean and calls the init method with the provided parametes. |
Method Summary | |
---|---|
int |
compareTo(java.lang.Object obj)
|
boolean |
equals(java.lang.Object obj)
|
java.lang.String |
getDescription()
Returns the value of the property PROPERTY_DESCRIPTION of this nav element, or null if this property is not set. |
java.lang.String |
getFileName()
Returns the filename of the nav element, i.e. |
java.lang.String |
getInfo()
Returns the value of the property of this nav element,
or null if this property is not set. |
java.lang.String |
getLocale()
Returns the value of the property of this nav element,
or null if this property is not set. |
java.lang.String |
getNavImage()
Returns the value of the property of this nav element,
or null if this property is not set. |
float |
getNavPosition()
Returns the value of the property C_PROPERTY_NAVPOS converted to a float ,
or a value of Float.MAX_VALUE if the nav position property is not
set (or not a valid number) for this resource. |
java.lang.String |
getNavText()
Returns the value of the property PROPERTY_NAVTEXT of this nav element, or a warning message if this property is not set (this method will never return null ). |
int |
getNavTreeLevel()
Returns the nav tree level of this resource. |
java.lang.String |
getParentFolderName()
Returns the name of the parent folder of the resource of this nav element. |
java.util.Map |
getProperties()
Returns the original Hashtable of all file properties of the resource that the nav element belongs to. |
java.lang.String |
getProperty(java.lang.String key)
Returns the value of the selected property from this nav element. |
java.lang.String |
getResourceName()
Returns the resource name this nav element was initalized with. |
java.lang.String |
getTitle()
Returns the value of the property PROPERTY_TITLE of this nav element, or null if this property is not set. |
int |
hashCode()
|
void |
init(java.lang.String resource,
java.util.Map properties)
Same as calling init(String, Hashtable, -1) . |
void |
init(java.lang.String resource,
java.util.Map properties,
int navTreeLevel)
Initialized the member variables of this bean with the values provided. |
boolean |
isFolderLink()
Returns true if this nav element describes a folder, false
otherwise. |
boolean |
isInNavigation()
Returns true if this nav element is in the navigation, false
otherwise. |
void |
setNavPosition(float value)
Sets the value that will be returned by the getNavPosition()
method of this class. |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public CmsJspNavElement()
Call one of the init methods afer you have created an instance of the bean. Instead of using the constructor you should use the static factory methods provided by this class to create navigation beans that are properly initialized with current OpenCms context.
CmsJspNavBuilder.getNavigationForResource()
,
CmsJspNavBuilder.getNavigationForFolder()
,
CmsJspNavBuilder.getNavigationTreeForFolder(int, int)
public CmsJspNavElement(java.lang.String resource, java.util.Map properties)
resource
- will be passed to init
properties
- will be passed to init
init(String, Map)
public CmsJspNavElement(java.lang.String resource, java.util.Map properties, int navTreeLevel)
resource
- will be passed to init
properties
- will be passed to init
navTreeLevel
- will be passed to init
init(String, Map, int)
Method Detail |
---|
public int compareTo(java.lang.Object obj)
compareTo
in interface java.lang.Comparable
Comparable.compareTo(Object)
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
Object.equals(Object)
public java.lang.String getDescription()
null
if this property is not set.
null
if this property is not setpublic java.lang.String getFileName()
public java.lang.String getInfo()
CmsPropertyDefinition.PROPERTY_NAVINFO
of this nav element,
or null
if this property is not set.
null
if this property is not setpublic java.lang.String getLocale()
CmsPropertyDefinition.PROPERTY_LOCALE
of this nav element,
or null
if this property is not set.
null
if this property is not setpublic java.lang.String getNavImage()
CmsPropertyDefinition.PROPERTY_NAVIMAGE
of this nav element,
or null
if this property is not set.
null
if this property is not setpublic float getNavPosition()
float
,
or a value of Float.MAX_VALUE
if the nav position property is not
set (or not a valid number) for this resource.
float
,
or a value of Float.MAX_VALUE
if the nav position property is not
set (or not a valid number) for this resourcepublic java.lang.String getNavText()
null
).
null
)public int getNavTreeLevel()
public java.lang.String getParentFolderName()
public java.util.Map getProperties()
Please note that the original reference is returned, so be careful when making changes to the Hashtable.
public java.lang.String getProperty(java.lang.String key)
The nav element contains a hash of all file properties of the resource that the nav element belongs to.
key
- the property name to look up
public java.lang.String getResourceName()
public java.lang.String getTitle()
null
if this property is not set.
null
if this property is not setpublic int hashCode()
hashCode
in class java.lang.Object
Object.hashCode()
public void init(java.lang.String resource, java.util.Map properties)
init(String, Hashtable, -1)
.
resource
- the name of the resource to extract the navigation
information fromproperties
- the properties of the resource read from the vfspublic void init(java.lang.String resource, java.util.Map properties, int navTreeLevel)
A resource will be in the nav if at least one of the two properties
I_CmsConstants.PROPERTY_NAVTEXT
or
I_CmsConstants.PROPERTY_NAVPOS
is set. Otherwise
it will be ignored.
This bean does provides static methods to create a new instance
from the context of a current CmsObject. Call these static methods
in order to get a properly initialized bean.
resource
- the name of the resource to extract the navigation
information fromproperties
- the properties of the resource read from the vfsnavTreeLevel
- tree level of this resource, for building
navigation treesCmsJspNavBuilder.getNavigationForResource()
public boolean isFolderLink()
true
if this nav element describes a folder, false
otherwise.
true
if this nav element describes a folder, false
otherwise.public boolean isInNavigation()
true
if this nav element is in the navigation, false
otherwise.A resource is considered to be in the navigation, if
CmsWorkplace.isTemporaryFileName(String)
.
true
if this nav element is in the navigation, false
otherwisepublic void setNavPosition(float value)
getNavPosition()
method of this class.
value
- the value to set
|
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |