org.opencms.jsp
Class CmsJspNavElement

java.lang.Object
  extended byorg.opencms.jsp.CmsJspNavElement
All Implemented Interfaces:
java.lang.Comparable

public class CmsJspNavElement
extends java.lang.Object
implements java.lang.Comparable

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.

Since:
6.0.0
Version:
$Revision: 1.15 $
Author:
Alexander Kandzior
See Also:
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 CmsPropertyDefinition.PROPERTY_NAVINFO of this nav element, or null if this property is not set.
 java.lang.String getLocale()
          Returns the value of the property CmsPropertyDefinition.PROPERTY_LOCALE of this nav element, or null if this property is not set.
 java.lang.String getNavImage()
          Returns the value of the property CmsPropertyDefinition.PROPERTY_NAVIMAGE 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

CmsJspNavElement

public CmsJspNavElement()
Empty constructor required for every JavaBean, does nothing.

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.

See Also:
CmsJspNavBuilder.getNavigationForResource(), CmsJspNavBuilder.getNavigationForFolder(), CmsJspNavBuilder.getNavigationTreeForFolder(int, int)

CmsJspNavElement

public 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.

Parameters:
resource - will be passed to init
properties - will be passed to init
See Also:
init(String, Map)

CmsJspNavElement

public 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.

Parameters:
resource - will be passed to init
properties - will be passed to init
navTreeLevel - will be passed to init
See Also:
init(String, Map, int)
Method Detail

compareTo

public int compareTo(java.lang.Object obj)
Specified by:
compareTo in interface java.lang.Comparable
See Also:
Comparable.compareTo(Object)

equals

public boolean equals(java.lang.Object obj)
See Also:
Object.equals(Object)

getDescription

public java.lang.String getDescription()
Returns the value of the property PROPERTY_DESCRIPTION of this nav element, or null if this property is not set.

Returns:
the value of the property PROPERTY_DESCRIPTION of this nav element or null if this property is not set

getFileName

public java.lang.String getFileName()
Returns the filename of the nav element, i.e. the name of the nav resource without any path information.

Returns:
the filename of the nav element, i.e. the name of the nav resource without any path information

getInfo

public java.lang.String getInfo()
Returns the value of the property CmsPropertyDefinition.PROPERTY_NAVINFO of this nav element, or null if this property is not set.

Returns:
the value of the property or null if this property is not set

getLocale

public java.lang.String getLocale()
Returns the value of the property CmsPropertyDefinition.PROPERTY_LOCALE of this nav element, or null if this property is not set.

Returns:
the value of the property or null if this property is not set

getNavImage

public java.lang.String getNavImage()
Returns the value of the property CmsPropertyDefinition.PROPERTY_NAVIMAGE of this nav element, or null if this property is not set.

Returns:
the value of the property or null if this property is not set

getNavPosition

public 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.

Returns:
float 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

getNavText

public 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).

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)

getNavTreeLevel

public int getNavTreeLevel()
Returns the nav tree level of this resource.

Returns:
int the nav tree level of this resource

getParentFolderName

public java.lang.String getParentFolderName()
Returns the name of the parent folder of the resource of this nav element.

Returns:
the name of the parent folder of the resource of this nav element

getProperties

public java.util.Map getProperties()
Returns the original Hashtable of all file properties of the resource that the nav element belongs to.

Please note that the original reference is returned, so be careful when making changes to the Hashtable.

Returns:
the original Hashtable of all file properties of the resource that the nav element belongs to

getProperty

public java.lang.String getProperty(java.lang.String key)
Returns the value of the selected property from this nav element.

The nav element contains a hash of all file properties of the resource that the nav element belongs to.

Parameters:
key - the property name to look up
Returns:
the value of the selected property

getResourceName

public java.lang.String getResourceName()
Returns the resource name this nav element was initalized with.

Returns:
the resource name this nav element was initalized with

getTitle

public java.lang.String getTitle()
Returns the value of the property PROPERTY_TITLE of this nav element, or null if this property is not set.

Returns:
the value of the property PROPERTY_TITLE of this nav element or null if this property is not set

hashCode

public int hashCode()
See Also:
Object.hashCode()

init

public void init(java.lang.String resource,
                 java.util.Map properties)
Same as calling init(String, Hashtable, -1).

Parameters:
resource - the name of the resource to extract the navigation information from
properties - the properties of the resource read from the vfs

init

public void init(java.lang.String resource,
                 java.util.Map properties,
                 int navTreeLevel)
Initialized the member variables of this bean with the values provided.

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.

Parameters:
resource - the name of the resource to extract the navigation information from
properties - the properties of the resource read from the vfs
navTreeLevel - tree level of this resource, for building navigation trees
See Also:
CmsJspNavBuilder.getNavigationForResource()

isFolderLink

public boolean isFolderLink()
Returns true if this nav element describes a folder, false otherwise.

Returns:
true if this nav element describes a folder, false otherwise.


isInNavigation

public boolean isInNavigation()
Returns true if this nav element is in the navigation, false otherwise.

A resource is considered to be in the navigation, if

  1. it has the property PROPERTY_NAVTEXT set
  2. or it has the property PROPERTY_NAVPOS set
  3. and it is not a temporary file that contains a '~' in it's filename.

Returns:
true if this nav element is in the navigation, false otherwise

setNavPosition

public void setNavPosition(float value)
Sets the value that will be returned by the getNavPosition() method of this class.

Parameters:
value - the value to set