org.olat.core.commons.modules.bc.components
Class FolderComponent

java.lang.Object
  org.olat.core.gui.components.Component
      org.olat.core.commons.modules.bc.components.FolderComponent

public class FolderComponent
extends Component

Initial Date: Feb 11, 2004

Author:

Mike Stock

Field Summary

static java.lang.String	SORT_DATE
static java.lang.String	SORT_LOCK
static java.lang.String	SORT_NAME
static java.lang.String	SORT_REV
static java.lang.String	SORT_SIZE
static java.lang.String	SORT_TYPE

Constructor Summary

FolderComponent(UserRequest ureq, java.lang.String name, VFSContainer rootContainer, java.util.Locale locale, VFSItemFilter filter)
Wrapps the folder module as a component.

Method Summary

VFSContainer	getCurrentContainer()
java.util.List<VFSItem>	getCurrentContainerChildren() Return the children of the folder of this FolderComponent.
java.lang.String	getCurrentContainerPath()
java.text.DateFormat	getDateTimeFormat()
ComponentRenderer	getHTMLRendererSingleton()
IdentityEnvironment	getIdentityEnvironnement()
VFSContainer	getRootContainer()
boolean	setCurrentContainerPath(java.lang.String relPath)
void	updateChildren()
void	validate(UserRequest ureq, ValidationResult vr) called just before the rendering of the -whole tree- takes place, so e.g.

Methods inherited from class org.olat.core.gui.components.Component

addListener, debuginfoGetListeners, dispatchRequest, getAndClearLatestFiredEvent, getComponentName, getDispatchID, getExtendedDebugInfo, getLatestDispatchedController, getListenerInfo, getParent, getSpanAsDomReplaceable, getTimestamp, getTranslator, isDirty, isDirtyForUser, isDomReplaceable, isEnabled, isVisible, setDirty, setDomReplaceable, setEnabled, setSpanAsDomReplaceable, setVisible, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

SORT_NAME

public static final java.lang.String SORT_NAME

See Also:

Constant Field Values

SORT_SIZE

public static final java.lang.String SORT_SIZE

See Also:

Constant Field Values

SORT_DATE

public static final java.lang.String SORT_DATE

See Also:

Constant Field Values

SORT_TYPE

public static final java.lang.String SORT_TYPE

See Also:

Constant Field Values

SORT_REV

public static final java.lang.String SORT_REV

See Also:

Constant Field Values

SORT_LOCK

public static final java.lang.String SORT_LOCK

See Also:

Constant Field Values

Constructor Detail

FolderComponent

public FolderComponent(UserRequest ureq,
                       java.lang.String name,
                       VFSContainer rootContainer,
                       java.util.Locale locale,
                       VFSItemFilter filter)

Wrapps the folder module as a component.

Parameters:

name -

folder -

secCallback -

filter -

Method Detail

getRootContainer

public VFSContainer getRootContainer()

Returns:

VFSContainer

getCurrentContainer

public VFSContainer getCurrentContainer()

Returns:

VFSContainer

getCurrentContainerPath

public java.lang.String getCurrentContainerPath()

getCurrentContainerChildren

public java.util.List<VFSItem> getCurrentContainerChildren()

Return the children of the folder of this FolderComponent. The children are already alphabetically sorted.

Returns:

updateChildren

public void updateChildren()

setCurrentContainerPath

public boolean setCurrentContainerPath(java.lang.String relPath)

Parameters:

relPath -

validate

public void validate(UserRequest ureq,
                     ValidationResult vr)

Description copied from class: Component

called just before the rendering of the -whole tree- takes place, so e.g. lazy fetching can be implemented, or issueing a request for a new moduleUri (e.g. for CPComponent, so that the browser loads images correctly). only called when the component is visible

Overrides:

validate in class Component

See Also:

Component.validate(org.olat.core.gui.UserRequest, org.olat.core.gui.render.ValidationResult)

getHTMLRendererSingleton

public ComponentRenderer getHTMLRendererSingleton()

Specified by:

getHTMLRendererSingleton in class Component

getIdentityEnvironnement

public IdentityEnvironment getIdentityEnvironnement()

getDateTimeFormat

public java.text.DateFormat getDateTimeFormat()