<w:FileBrowser>

FileBrower provides server-side directory browsing.

The base directory's file listing is displayed initially in a AWTDataTable. The columns are file name, size, and last modified date. Links on the name allows users to cd down into a sub-directory. A global button at the bottom allows users to cd up into the parent directory. Each file has a select button for selection. Filter can used to filter listings.

Bindings

baseDirectory	The directory to start file listing. Depending on the value of the binding "allowCdUp", users may or may not cd up above this directory. If not present, the root directory is used.	File (get)
selection *	The selected file object that is set after user selects a directory.	File (set)
action *	This is invoked after the selected file has been set.	AWResponseGenerating (get)
fileFilter	If this is present, it is used to filter all listings. Useful for filtering by file properties (ie, isDirectory, size, etc).	FileFilter (get)
filenameFilter	If this is present and fileFilter is not, it is used to filter all listings. Useful for filtering by file name patterns (ie, file extensions).	FilenameFilter (get)
enableScrolling	Determines whether the table adds scrollbars for content that won't fit within browser window.	boolean (get)
showOptionsMenu	Whether the table should provide an "Options" popup menu to support show/hide of columns, grouping, and Excel export.	boolean (get)
batchSize	Number of row per page to display in table. Default is 20. This batch size is only used if scrolling is disabled. If scrolling is enabled, then "scroll faulting" is used instead (with a fixed batch size).	int (get)
allowCdUp	Whether users be allowed to cd up from the baseDirectory. The default value is false, or users are not allowed cd up beyond the baseDirectory.	boolean (get)

ariba.ui.widgets
Class FileBrowser

java.lang.Object
  ariba.ui.aribaweb.util.AWBaseObject
      ariba.ui.aribaweb.core.AWComponent
          ariba.ui.widgets.FileBrowser

All Implemented Interfaces:

AWCycleable, AWCycleableReference, AWResponseGenerating, AWResponseGenerating.ResponseSubstitution, AWObject

public class FileBrowser
extends AWComponent

Nested Class Summary

Nested classes/interfaces inherited from class ariba.ui.aribaweb.core.AWComponent

AWComponent.RenderingFilter, AWComponent.RenderingListener

Nested classes/interfaces inherited from interface ariba.ui.aribaweb.core.AWResponseGenerating

AWResponseGenerating.ResponseSubstitution

Constructor Summary

FileBrowser()

Method Summary

boolean	canCdUp()
boolean	canNotCdInto()
AWComponent	cdDownAction()
AWComponent	cdIntoAction()
AWComponent	cdUpAction()
java.lang.String	currentDirectoryLinkName()
java.lang.String	currentDirectoryName()
java.lang.String	currentFileLastModified()
java.lang.String	currentFileName()
long	currentFileSize()
java.lang.String	currentParentDirectoryName()
java.util.List	directoryLinks()
void	init()
boolean	isSizeVisible()
boolean	isStateless() Overridden by AWComponent subclasses to indicate whether component instances should be preserved with the page/session (i.e.
AWComponent	openClicked()
AWComponent	selectClicked()
java.lang.String[]	supportedBindingNames()

Methods inherited from class ariba.ui.aribaweb.core.AWComponent

_topLevelApplyValues, _topLevelInvokeAction, _topLevelRenderResponse, allowEmbeddedKeyPaths, allowsWhitespaceCompression, application, applyValues, awcyclePageAndLog, bindingForName, bindingForName, bindings, booleanValueForBinding, booleanValueForBinding, booleanValueForBinding, booleanValueForBinding, browserMaxWidth, browserMinWidth, characterEncoding, clearValidationError, clientTimeZone, componentConfiguration, componentDefinition, componentPath, componentReference, createPageWithName, defaultTemplateParser, determineInstance, determineInstance, dict, dict, dict, doubleValueForBinding, doubleValueForBinding, doubleValueForBinding, encodedStringValueForBinding, encodedStringValueForBinding, ensureAwake, ensureFieldValuesClear, env, errorManager, escapeAttribute, escapeString, escapeUnsafeString, extendedFields, formValueManager, generateResponse, generateResponse, generateResponse, generateStringContents, getAWParameter, getDrivingBusinessObject, getFoldInSituOnWindowSizeParam, getPageRenderVersion, getThis, hasBinding, hasBinding, hasContentForTagName, hasContentNamed, hasMultipleTemplates, hasSubTemplateNamed, httpSession, init, initTemplateResourceManager, intValueForBinding, intValueForBinding, intValueForBinding, invokeAction, isBidirectional, isBrowserMicrosoft, isClientPanel, isMacintosh, isRenderAW5, isStrictTagNaming, isUserCommunityEnabled, isValidationEnabled, languageDirection, languageLeft, languageRight, loadTemplate, localizedJavaString, markBacktrackState, name, namePath, notifyChange, otherBindings, otherBindingsValues, page, pageComponent, pageWithClass, pageWithClass, pageWithName, pageWithName, parent, postTakeValueActions, preferredLocale, recordBacktrackState, recordBacktrackState, recordValidationError, recordValidationError, recordValidationError, recordValidationErrors, recordValidationWarning, redirectToPage, registerRenderingListener, registerXmlNodeWithName, removeBacktrackState, renderResponse, replacementResponse, request, requestContext, requiresPreGlidCompatibility, resourceClassName, resourceManager, response, restoreFromBacktrackState, session, session, setCharacterEncoding, setClientPanel, setClientTimeZone, setComponentConfiguration, setDefaultTemplateParser, setEnv, setPerfDestinationInfo, setPreferredLocale, setResourceManager, setTemplateParser, setupForNextCycle, setValueForBinding, setValueForBinding, setValueForBinding, setValueForBinding, setValueForBinding, setValueForBinding, shouldCachePage, shouldCloseElements, strings, stringValueForBinding, stringValueForBinding, stringValueForBinding, template, templateName, templateParser, templateResource, templateResourceManager, truncateBacktrackState, truncateBacktrackState, urlForResourceNamed, urlForResourceNamed, urlForResourceNamed, useXmlEscaping, valueForBinding, valueForBinding, valueForBinding, xml

Methods inherited from class ariba.ui.aribaweb.util.AWBaseObject

debugString, getFieldValue, isKindOfClass, localizedJavaString, logString, logWarning, setFieldValue

Methods inherited from class java.lang.Object

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

Methods inherited from interface ariba.ui.aribaweb.util.AWObject

getFieldValue, isKindOfClass, setFieldValue

Field Detail

baseDirectory

public static final java.lang.String baseDirectory

See Also:

Constant Field Values

fileFilter

public static final java.lang.String fileFilter

See Also:

Constant Field Values

filenameFilter

public static final java.lang.String filenameFilter

See Also:

Constant Field Values

allowCdUp

public static final java.lang.String allowCdUp

See Also:

Constant Field Values

SuperRootDirectory

public static final ariba.ui.widgets.FileBrowser.SuperRootDir SuperRootDirectory

separator

public static final java.lang.String separator

_displayGroup

public AWTDisplayGroup _displayGroup

_currentDirectory

public java.io.File _currentDirectory

_currentFile

public java.io.File _currentFile

_baseDirectory

public java.io.File _baseDirectory

_currentDirectoryLink

public java.io.File _currentDirectoryLink

_allowCdUp

public boolean _allowCdUp

Constructor Detail

FileBrowser

public FileBrowser()

Method Detail

isStateless

public boolean isStateless()

Description copied from class: AWComponent

Overridden by AWComponent subclasses to indicate whether component instances should be preserved with the page/session (i.e. are "stateful") or can be pooled and reused for each phase of request processing (i.e. are stateless) Default is to be stateless unless the component is used as the top-level (page) component.

Overrides:

isStateless in class AWComponent

supportedBindingNames

public java.lang.String[] supportedBindingNames()

Overrides:

supportedBindingNames in class AWComponent

init

public void init()

Specified by:

init in interface AWObject

Overrides:

init in class AWComponent

directoryLinks

public java.util.List directoryLinks()
                              throws java.io.IOException

Throws:

java.io.IOException

currentDirectoryLinkName

public java.lang.String currentDirectoryLinkName()

currentFileName

public java.lang.String currentFileName()

currentDirectoryName

public java.lang.String currentDirectoryName()

currentParentDirectoryName

public java.lang.String currentParentDirectoryName()

currentFileSize

public long currentFileSize()

currentFileLastModified

public java.lang.String currentFileLastModified()

canCdUp

public boolean canCdUp()

canNotCdInto

public boolean canNotCdInto()

isSizeVisible

public boolean isSizeVisible()

cdDownAction

public AWComponent cdDownAction()

cdUpAction

public AWComponent cdUpAction()

cdIntoAction

public AWComponent cdIntoAction()

selectClicked

public AWComponent selectClicked()

openClicked

public AWComponent openClicked()