java.lang.Object
- org.silverpeas.core.web.mvc.webcomponent.NavigationContext.NavigationStep

Enclosing class:

NavigationContext<C extends WebComponentRequestContext>
```
public class NavigationContext.NavigationStep
extends Object
```
Class that represents the data of a navigation step. This class is used for automatically set informatons to a browse bar element.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`getContextIdentifier()`	Gets the identifier of a context associated to the navigation step.
`String`	`getIdentifier()`	Gets the identifier of the navigation step.
`String`	`getLabel()`	Gets a functional label of the navigation step.
`NavigationContext<C>`	`getNavigationContext()`	Gets the navigation context the navigation step is associated to.
`NavigationContext.NavigationStep`	`getNext()`	Gets the next navigation step.
`NavigationContext.NavigationStep`	`getPrevious()`	Gets the previous navigation step.
`URI`	`getUri()`	Gets the URI associated to the navigation step.
`boolean`	`isUriMustBeUsedByBrowseBar()`	Indicates if the URI of the navigation step must be used by the browsbar mechanism.
`NavigationContext.NavigationStep`	`setUriMustBeUsedByBrowseBar(boolean uriMustBeUsedByBrowseBar)`	Sets if the URI of the navigation step must be used by the browsbar mechanism.
`NavigationContext.NavigationStep`	`withContextIdentifier(String contextIdentifier)`	Sets the identifier of a context associated to the navigation step.
`NavigationContext.NavigationStep`	`withFullUri(String fullUri)`	Sets the URI associated to the navigation step.
`NavigationContext.NavigationStep`	`withLabel(String label)`	Sets a functional label of the navigation step.
`NavigationContext.NavigationStep`	`withSuffixUri(String suffixUri)`	Sets the URI associated to the navigation step.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getNavigationContext
```
public NavigationContext<C> getNavigationContext()
```
    Gets the navigation context the navigation step is associated to.
    
    Returns:
  - getIdentifier
```
public String getIdentifier()
```
    Gets the identifier of the navigation step.
    
    Returns:
    
    the above described identifier.
  - getContextIdentifier
```
public String getContextIdentifier()
```
    Gets the identifier of a context associated to the navigation step.
    
    Returns:
    
    the above described identifier.
  - withContextIdentifier
```
public NavigationContext.NavigationStep withContextIdentifier(String contextIdentifier)
```
    Sets the identifier of a context associated to the navigation step.
    
    Parameters:
    
    contextIdentifier - a context identifier.
    
    Returns:
    
    itself.
  - getLabel
```
public String getLabel()
```
    Gets a functional label of the navigation step. It is especially used by BrowseBarTag tag.
    
    Returns:
    
    the above described label.
  - withLabel
```
public NavigationContext.NavigationStep withLabel(String label)
```
    Sets a functional label of the navigation step. It is especially used by BrowseBarTag tag.
    
    Parameters:
    
    label - a label.
    
    Returns:
    
    itself.
  - getUri
```
public URI getUri()
```
    Gets the URI associated to the navigation step. It is normally the URI performed when the navigation step has been created or reset. But in some cases, it has been modified manually from Web Controller.
    
    Returns:
    
    the above described URI.
  - withFullUri
```
public NavigationContext.NavigationStep withFullUri(String fullUri)
```
    Sets the URI associated to the navigation step.
    
    Parameters:
    
    fullUri - the URI to set.
    
    Returns:
    
    itself.
  - withSuffixUri
```
public NavigationContext.NavigationStep withSuffixUri(String suffixUri)
```
    Sets the URI associated to the navigation step.
    
    Parameters:
    
    suffixUri - the suffic URI that will be added to the prefix composed with WebComponentRequestContext.getComponentUriBase() information.
    
    Returns:
    
    itself.
  - getPrevious
```
public NavigationContext.NavigationStep getPrevious()
```
    Gets the previous navigation step.
    
    Returns:
    
    the previous navigation step if any, null otherwise.
  - getNext
```
public NavigationContext.NavigationStep getNext()
```
    Gets the next navigation step.
    
    Returns:
    
    the next navigation step if any, null otherwise.
  - isUriMustBeUsedByBrowseBar
```
public boolean isUriMustBeUsedByBrowseBar()
```
    Indicates if the URI of the navigation step must be used by the browsbar mechanism. True by default.
    
    Returns:
    
    true if must be used, false otherwise.
  - setUriMustBeUsedByBrowseBar
```
public NavigationContext.NavigationStep setUriMustBeUsedByBrowseBar(boolean uriMustBeUsedByBrowseBar)
```
    Sets if the URI of the navigation step must be used by the browsbar mechanism. True by default.
    
    Parameters:
    
    uriMustBeUsedByBrowseBar - true if must be used, false otherwise.
    
    Returns:
    
    itself.

Class NavigationContext.NavigationStep

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getNavigationContext

getIdentifier

getContextIdentifier

withContextIdentifier

getLabel

withLabel

getUri

withFullUri

withSuffixUri

getPrevious

getNext

isUriMustBeUsedByBrowseBar

setUriMustBeUsedByBrowseBar