org.opencms.widgets

类 CmsVfsFileWidget

java.lang.Object

org.opencms.widgets.A_CmsWidget

org.opencms.widgets.CmsVfsFileWidget

所有已实现的接口:

I_CmsADEWidget, I_CmsWidget

public class CmsVfsFileWidget
extends A_CmsWidget
implements I_CmsADEWidget

Provides a OpenCms VFS file selection widget, for use on a widget dialog.

从以下版本开始:

6.0.0

嵌套类概要

嵌套类

限定符和类型	类和说明
protected class	CmsVfsFileWidget.SearchTypesFactory Macro resolver factory to get the default searchable types.

从类继承的嵌套类/接口 org.opencms.widgets.A_CmsWidget

A_CmsWidget.CmsDummyWidgetDialog

字段概要

字段

限定符和类型	字段和说明
static java.lang.String	CONFIGURATION_EXCLUDEFILES Configuration parameter to set the flag to include files in popup resource tree.
static java.lang.String	CONFIGURATION_HIDESITESELECTOR Configuration parameter to set the flag to show the site selector in popup resource tree.
static java.lang.String	CONFIGURATION_INCLUDEFILES Configuration parameter to set the flag to include files in popup resource tree.
static java.lang.String	CONFIGURATION_NOTPROJECTAWARE Configuration parameter to prevent the project awareness flag in the popup resource tree.
static java.lang.String	CONFIGURATION_PROJECTAWARE Configuration parameter to set the project awareness flag in the popup resource tree.
static java.lang.String	CONFIGURATION_SEARCHTYPES Configuration parameter to set search types of the gallery widget.
static java.lang.String	CONFIGURATION_SELECTABLETYPES Configuration parameter to set the selectable types of the gallery widget.
static java.lang.String	CONFIGURATION_SHOWSITESELECTOR Configuration parameter to set the flag to show the site selector in popup resource tree.
static java.lang.String	CONFIGURATION_STARTFOLDER Configuration parameter to set start folder.
static java.lang.String	CONFIGURATION_STARTSITE Configuration parameter to set start site of the popup resource tree.
static java.lang.String	DEFAULT_SEARCH_TYPES_MACRO The default search types macro name.

从类继承的字段 org.opencms.widgets.A_CmsWidget

HELP_POSTFIX, LABEL_PREFIX

构造器概要

构造器

构造器和说明
CmsVfsFileWidget() Creates a new vfs file widget.
CmsVfsFileWidget(boolean showSiteSelector, java.lang.String startSite) Creates a new vfs file widget with the parameters to configure the popup tree window behavior.
CmsVfsFileWidget(boolean showSiteSelector, java.lang.String startSite, boolean includeFiles) Creates a new vfs file widget with the parameters to configure the popup tree window behavior.
CmsVfsFileWidget(boolean showSiteSelector, java.lang.String startSite, boolean includeFiles, boolean projectAware) Creates a new vfs file widget with the parameters to configure the popup tree window behavior.
CmsVfsFileWidget(java.lang.String configuration) Creates a new vfs file widget with the given configuration.

方法概要

方法

限定符和类型	方法和说明
java.lang.String	getConfiguration() Returns the configuration string.
java.lang.String	getConfiguration(CmsObject cms, A_CmsXmlContentValue schemaType, CmsMessages messages, CmsResource resource, java.util.Locale contentLocale) Returns the configuration string for the ADE content editor widget.
java.util.List<java.lang.String>	getCssResourceLinks(CmsObject cms) Returns a list of CSS resources required by the widget.
I_CmsXmlContentHandler.DisplayType	getDefaultDisplayType() Returns the default display type of this widget.
protected static java.lang.String	getDefaultSearchTypes(CmsObject cms, CmsResource resource) Returns a comma separated list of the default search type names.
java.lang.String	getDialogIncludes(CmsObject cms, I_CmsWidgetDialog widgetDialog) Generates the necessary JavaScript inclusion code for this widget.
java.lang.String	getDialogInitCall(CmsObject cms, I_CmsWidgetDialog widgetDialog) Generates the initialisation method JavaScript code for this widget.
java.lang.String	getDialogInitMethod(CmsObject cms, I_CmsWidgetDialog widgetDialog) Generates the initialization method JavaScript code for this widget.
java.lang.String	getDialogWidget(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param) Generates the widget HTML for the provided widget parameter.
java.lang.String	getInitCall() Returns the java script initialization call.
java.util.List<java.lang.String>	getJavaScriptResourceLinks(CmsObject cms) Returns a list of java script resources required by the widget.
protected JSONObject	getJsonConfig(CmsObject cms, A_CmsXmlContentValue schemaType, CmsMessages messages, CmsResource resource, java.util.Locale contentLocale) Gets the JSON configuration.
java.lang.String	getStartSite() Returns the start site root shown by the widget when first displayed.
protected java.lang.String	getTreeToken(CmsObject cms, A_CmsXmlContentValue value, CmsResource resource, java.util.Locale contentLocale) Computes the tree token, which is used to decide which preloaded tree, if any, to load for the VFS/sitemap tabs.
java.lang.String	getWidgetName() Returns the class name of the widget.
boolean	isInternal() Returns if this is an internal widget.
boolean	isShowingSiteSelector() Returns true if the site selector is shown.
I_CmsWidget	newInstance() Creates a duplicate of this widget instance.
void	setConfiguration(java.lang.String configuration) Sets the configuration of this widget.

从类继承的方法 org.opencms.widgets.A_CmsWidget

equals, getDialogHtmlEnd, getHelpBubble, getHelpKey, getHelpText, getJsHelpMouseHandler, getJSIncludeFile, getLabelKey, getWidgetStringValue, hashCode, isCompactViewEnabled, setEditorValue

从类继承的方法 java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

从接口继承的方法 org.opencms.widgets.I_CmsWidget

getDialogHtmlEnd, getHelpBubble, getHelpText, getWidgetStringValue, isCompactViewEnabled, setEditorValue

字段详细资料

CONFIGURATION_EXCLUDEFILES

public static final java.lang.String CONFIGURATION_EXCLUDEFILES

Configuration parameter to set the flag to include files in popup resource tree.

另请参阅:

常量字段值

CONFIGURATION_HIDESITESELECTOR

public static final java.lang.String CONFIGURATION_HIDESITESELECTOR

Configuration parameter to set the flag to show the site selector in popup resource tree.

另请参阅:

常量字段值

CONFIGURATION_INCLUDEFILES

public static final java.lang.String CONFIGURATION_INCLUDEFILES

Configuration parameter to set the flag to include files in popup resource tree.

另请参阅:

常量字段值

CONFIGURATION_NOTPROJECTAWARE

public static final java.lang.String CONFIGURATION_NOTPROJECTAWARE

Configuration parameter to prevent the project awareness flag in the popup resource tree.

另请参阅:

常量字段值

CONFIGURATION_PROJECTAWARE

public static final java.lang.String CONFIGURATION_PROJECTAWARE

Configuration parameter to set the project awareness flag in the popup resource tree.

另请参阅:

常量字段值

CONFIGURATION_SEARCHTYPES

public static final java.lang.String CONFIGURATION_SEARCHTYPES

Configuration parameter to set search types of the gallery widget.

另请参阅:

常量字段值

CONFIGURATION_SELECTABLETYPES

public static final java.lang.String CONFIGURATION_SELECTABLETYPES

Configuration parameter to set the selectable types of the gallery widget.

另请参阅:

常量字段值

CONFIGURATION_SHOWSITESELECTOR

public static final java.lang.String CONFIGURATION_SHOWSITESELECTOR

Configuration parameter to set the flag to show the site selector in popup resource tree.

另请参阅:

常量字段值

CONFIGURATION_STARTFOLDER

public static final java.lang.String CONFIGURATION_STARTFOLDER

Configuration parameter to set start folder.

另请参阅:

常量字段值

CONFIGURATION_STARTSITE

public static final java.lang.String CONFIGURATION_STARTSITE

Configuration parameter to set start site of the popup resource tree.

另请参阅:

常量字段值

DEFAULT_SEARCH_TYPES_MACRO

public static final java.lang.String DEFAULT_SEARCH_TYPES_MACRO

The default search types macro name.

另请参阅:

常量字段值

构造器详细资料

CmsVfsFileWidget

public CmsVfsFileWidget()

Creates a new vfs file widget.

CmsVfsFileWidget

public CmsVfsFileWidget(boolean showSiteSelector,
                java.lang.String startSite)

Creates a new vfs file widget with the parameters to configure the popup tree window behavior.

参数:

showSiteSelector - true if the site selector should be shown in the popup window

startSite - the start site root for the popup window

CmsVfsFileWidget

public CmsVfsFileWidget(boolean showSiteSelector,
                java.lang.String startSite,
                boolean includeFiles)

Creates a new vfs file widget with the parameters to configure the popup tree window behavior.

参数:

showSiteSelector - true if the site selector should be shown in the popup window

startSite - the start site root for the popup window

includeFiles - true if files should be shown in the popup window

CmsVfsFileWidget

public CmsVfsFileWidget(boolean showSiteSelector,
                java.lang.String startSite,
                boolean includeFiles,
                boolean projectAware)

Creates a new vfs file widget with the parameters to configure the popup tree window behavior.

参数:

showSiteSelector - true if the site selector should be shown in the popup window

startSite - the start site root for the popup window

includeFiles - true if files should be shown in the popup window

projectAware - true if resources outside of the current project should be displayed as normal

CmsVfsFileWidget

public CmsVfsFileWidget(java.lang.String configuration)

Creates a new vfs file widget with the given configuration.

参数:

configuration - the configuration to use

方法详细资料

getDefaultSearchTypes

protected static java.lang.String getDefaultSearchTypes(CmsObject cms,
                                     CmsResource resource)

Returns a comma separated list of the default search type names.

参数:

cms - the CMS context

resource - the edited resource

返回:

a comma separated list of the default search type names

getConfiguration

public java.lang.String getConfiguration()

从类复制的说明: A_CmsWidget

Returns the configuration string.

指定者:

getConfiguration 在接口中 I_CmsWidget

覆盖:

getConfiguration 在类中 A_CmsWidget

返回:

the configuration string

另请参阅:

A_CmsWidget.getConfiguration()

getConfiguration

public java.lang.String getConfiguration(CmsObject cms,
                                A_CmsXmlContentValue schemaType,
                                CmsMessages messages,
                                CmsResource resource,
                                java.util.Locale contentLocale)

从接口复制的说明: I_CmsADEWidget

Returns the configuration string for the ADE content editor widget.

指定者:

getConfiguration 在接口中 I_CmsADEWidget

参数:

cms - the OpenCms context

schemaType - the schema type

messages - the messages

resource - the edited resource

contentLocale - the content locale

返回:

the configuration string

另请参阅:

I_CmsADEWidget.getConfiguration(org.opencms.file.CmsObject, org.opencms.xml.types.A_CmsXmlContentValue, org.opencms.i18n.CmsMessages, org.opencms.file.CmsResource, java.util.Locale)

getCssResourceLinks

public java.util.List<java.lang.String> getCssResourceLinks(CmsObject cms)

从接口复制的说明: I_CmsADEWidget

Returns a list of CSS resources required by the widget.

指定者:

getCssResourceLinks 在接口中 I_CmsADEWidget

参数:

cms - the current OpenCms context

返回:

the required CSS resource links

另请参阅:

I_CmsADEWidget.getCssResourceLinks(org.opencms.file.CmsObject)

getDefaultDisplayType

public I_CmsXmlContentHandler.DisplayType getDefaultDisplayType()

从接口复制的说明: I_CmsADEWidget

Returns the default display type of this widget.

指定者:

getDefaultDisplayType 在接口中 I_CmsADEWidget

返回:

the default display type

另请参阅:

I_CmsADEWidget.getDefaultDisplayType()

getDialogIncludes

public java.lang.String getDialogIncludes(CmsObject cms,
                                 I_CmsWidgetDialog widgetDialog)

从接口复制的说明: I_CmsWidget

Generates the necessary JavaScript inclusion code for this widget.

指定者:

getDialogIncludes 在接口中 I_CmsWidget

覆盖:

getDialogIncludes 在类中 A_CmsWidget

参数:

cms - the current users OpenCms context

widgetDialog - the dialog where the widget is used on

返回:

the JavaScript inclusion code

另请参阅:

I_CmsWidget.getDialogIncludes(org.opencms.file.CmsObject, org.opencms.widgets.I_CmsWidgetDialog)

getDialogInitCall

public java.lang.String getDialogInitCall(CmsObject cms,
                                 I_CmsWidgetDialog widgetDialog)

从接口复制的说明: I_CmsWidget

Generates the initialisation method JavaScript code for this widget.

指定者:

getDialogInitCall 在接口中 I_CmsWidget

覆盖:

getDialogInitCall 在类中 A_CmsWidget

参数:

cms - the current users OpenCms context

widgetDialog - the dialog where the widget is used on

返回:

the initialisation method JavaScript code

另请参阅:

I_CmsWidget.getDialogInitCall(org.opencms.file.CmsObject, org.opencms.widgets.I_CmsWidgetDialog)

getDialogInitMethod

public java.lang.String getDialogInitMethod(CmsObject cms,
                                   I_CmsWidgetDialog widgetDialog)

从接口复制的说明: I_CmsWidget

Generates the initialization method JavaScript code for this widget.

指定者:

getDialogInitMethod 在接口中 I_CmsWidget

覆盖:

getDialogInitMethod 在类中 A_CmsWidget

参数:

cms - an initialized instance of a CmsObject

widgetDialog - the dialog where the widget is used on

返回:

the initialization method JavaScript code

另请参阅:

I_CmsWidget.getDialogInitMethod(org.opencms.file.CmsObject, org.opencms.widgets.I_CmsWidgetDialog)

getDialogWidget

public java.lang.String getDialogWidget(CmsObject cms,
                               I_CmsWidgetDialog widgetDialog,
                               I_CmsWidgetParameter param)

从接口复制的说明: I_CmsWidget

Generates the widget HTML for the provided widget parameter.

指定者:

getDialogWidget 在接口中 I_CmsWidget

参数:

cms - an initialized instance of a CmsObject

widgetDialog - the dialog where the widget is used on

param - the widget parameter to generate the widget for

返回:

the widget HTML for the provided widget parameter

另请参阅:

I_CmsWidget.getDialogWidget(org.opencms.file.CmsObject, org.opencms.widgets.I_CmsWidgetDialog, org.opencms.widgets.I_CmsWidgetParameter)

getInitCall

public java.lang.String getInitCall()

从接口复制的说明: I_CmsADEWidget

Returns the java script initialization call.

指定者:

getInitCall 在接口中 I_CmsADEWidget

返回:

the java script initialization call

另请参阅:

I_CmsADEWidget.getInitCall()

getJavaScriptResourceLinks

public java.util.List<java.lang.String> getJavaScriptResourceLinks(CmsObject cms)

从接口复制的说明: I_CmsADEWidget

Returns a list of java script resources required by the widget.

指定者:

getJavaScriptResourceLinks 在接口中 I_CmsADEWidget

参数:

cms - the current OpenCms context

返回:

the required java script resource links

另请参阅:

I_CmsADEWidget.getJavaScriptResourceLinks(org.opencms.file.CmsObject)

getStartSite

public java.lang.String getStartSite()

Returns the start site root shown by the widget when first displayed.

If null is returned, the dialog will display the current site of the current user.

返回:

the start site root shown by the widget when first displayed

getWidgetName

public java.lang.String getWidgetName()

从接口复制的说明: I_CmsADEWidget

Returns the class name of the widget.

指定者:

getWidgetName 在接口中 I_CmsADEWidget

返回:

the class name

另请参阅:

I_CmsADEWidget.getWidgetName()

isInternal

public boolean isInternal()

从接口复制的说明: I_CmsADEWidget

Returns if this is an internal widget.

Only widgets belonging to the OpenCms core should be marked as internal.

指定者:

isInternal 在接口中 I_CmsADEWidget

返回:

true if this is an internal widget

另请参阅:

I_CmsADEWidget.isInternal()

isShowingSiteSelector

public boolean isShowingSiteSelector()

Returns true if the site selector is shown.

The default is true.

返回:

true if the site selector is shown

newInstance

public I_CmsWidget newInstance()

从接口复制的说明: I_CmsWidget

Creates a duplicate of this widget instance.

指定者:

newInstance 在接口中 I_CmsWidget

返回:

a duplicate of this widget instance

另请参阅:

I_CmsWidget.newInstance()

setConfiguration

public void setConfiguration(java.lang.String configuration)

从接口复制的说明: I_CmsWidget

Sets the configuration of this widget.

This can be used to enable / disable certain widget features that should not always be available, or to pass specific initialization information to the widget. It depends on the widget implementation on how this information is used.

指定者:

setConfiguration 在接口中 I_CmsWidget

覆盖:

setConfiguration 在类中 A_CmsWidget

参数:

configuration - the configuration to set

另请参阅:

A_CmsWidget.setConfiguration(java.lang.String)

getJsonConfig

protected JSONObject getJsonConfig(CmsObject cms,
                       A_CmsXmlContentValue schemaType,
                       CmsMessages messages,
                       CmsResource resource,
                       java.util.Locale contentLocale)

Gets the JSON configuration.

参数:

cms - the current CMS context

schemaType - the schema type

messages - the messages

resource - the content resource

contentLocale - the content locale

返回:

the JSON configuration object

getTreeToken

protected java.lang.String getTreeToken(CmsObject cms,
                            A_CmsXmlContentValue value,
                            CmsResource resource,
                            java.util.Locale contentLocale)

Computes the tree token, which is used to decide which preloaded tree, if any, to load for the VFS/sitemap tabs.

参数:

cms - the current CMS context

value - the content value

resource - the content resource

contentLocale - the content locale

返回:

the tree token