org.opencms.ade.galleries.shared

枚举 CmsGallerySearchScope

java.lang.Object

java.lang.Enum<CmsGallerySearchScope>

org.opencms.ade.galleries.shared.CmsGallerySearchScope

所有已实现的接口:

java.io.Serializable, java.lang.Comparable<CmsGallerySearchScope>

public enum CmsGallerySearchScope
extends java.lang.Enum<CmsGallerySearchScope>

An enum that represents the possible search scope choices in the ADE gallery search tab.

枚举常量概要

枚举常量

枚举常量和说明
everything Search everything.
shared Search only in the shared folder.
site Search in the current site.
siteShared Search in the current site and the shared folder.
subSite Search in the current subsite.
subSiteShared Search in the current subsite and the shared folder.

方法概要

方法

限定符和类型	方法和说明
java.lang.String	getKey() Returns the localization key for the choice.
boolean	isIncludeShared() Returns if this search scope includes the shared folder.
boolean	isIncludeSite() Returns if this search scope includes the site folder.
boolean	isIncludeSubSite() Returns if this search scope includes the sub site folder.
static CmsGallerySearchScope	valueOf(java.lang.String name) 返回带有指定名称的该类型的枚举常量。
static CmsGallerySearchScope[]	values() 按照声明该枚举类型的常量的顺序, 返回 包含这些常量的数组。

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

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

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

getClass, notify, notifyAll, wait, wait, wait

枚举常量详细资料

everything

public static final CmsGallerySearchScope everything

Search everything.

shared

public static final CmsGallerySearchScope shared

Search only in the shared folder.

site

public static final CmsGallerySearchScope site

Search in the current site.

siteShared

public static final CmsGallerySearchScope siteShared

Search in the current site and the shared folder.

subSite

public static final CmsGallerySearchScope subSite

Search in the current subsite.

subSiteShared

public static final CmsGallerySearchScope subSiteShared

Search in the current subsite and the shared folder.

方法详细资料

values

public static CmsGallerySearchScope[] values()

按照声明该枚举类型的常量的顺序, 返回 包含这些常量的数组。该方法可用于迭代 常量, 如下所示:

for (CmsGallerySearchScope c : CmsGallerySearchScope.values())
    System.out.println(c);

返回:

按照声明该枚举类型的常量的顺序, 返回 包含这些常量的数组

valueOf

public static CmsGallerySearchScope valueOf(java.lang.String name)

返回带有指定名称的该类型的枚举常量。 字符串必须与用于声明该类型的枚举常量的 标识符完全匹配。(不允许有多余 的空格字符。)

参数:

name - 要返回的枚举常量的名称。

返回:

返回带有指定名称的枚举常量

抛出:

如果该枚举类型没有带有指定名称的常量, - 则抛出 IllegalArgumentException

如果参数为空值, - 则抛出 NullPointerException

getKey

public java.lang.String getKey()

Returns the localization key for the choice.

返回:

the localization key for the choice

isIncludeShared

public boolean isIncludeShared()

Returns if this search scope includes the shared folder.

返回:

true if this search scope includes the shared folder

isIncludeSite

public boolean isIncludeSite()

Returns if this search scope includes the site folder.

返回:

true if this search scope includes the site folder

isIncludeSubSite

public boolean isIncludeSubSite()

Returns if this search scope includes the sub site folder.

返回:

true if this search scope includes the sub site folder