org.opencms.ade.galleries.client.ui

类 CmsGalleryField

java.lang.Object

com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.Widget

com.google.gwt.user.client.ui.Composite

org.opencms.ade.galleries.client.ui.CmsGalleryField

所有已实现的接口:

com.google.gwt.event.dom.client.HasFocusHandlers, com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.logical.shared.HasResizeHandlers, com.google.gwt.event.logical.shared.HasValueChangeHandlers<java.lang.String>, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.IsRenderable, com.google.gwt.user.client.ui.IsWidget, I_CmsHasInit, I_CmsFormWidget

直接已知子类:

CmsImageGalleryField

public class CmsGalleryField
extends com.google.gwt.user.client.ui.Composite
implements I_CmsFormWidget, I_CmsHasInit, com.google.gwt.event.logical.shared.HasValueChangeHandlers<java.lang.String>, com.google.gwt.event.logical.shared.HasResizeHandlers, com.google.gwt.event.dom.client.HasFocusHandlers

A widget for selecting a resource from an ADE gallery dialog.

从以下版本开始:

8.0.0

嵌套类概要

嵌套类

限定符和类型	类和说明
protected static interface	CmsGalleryField.I_CmsGalleryFieldUiBinder The UI Binder interface for this widget.
protected class	CmsGalleryField.OpenCloseHandler Handler to fire resize event on resource info widget open/close.

从类继承的嵌套类/接口 com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled

从接口继承的嵌套类/接口 org.opencms.gwt.client.ui.input.I_CmsFormWidget

I_CmsFormWidget.FieldType

字段概要

字段

限定符和类型	字段和说明
protected I_CmsGalleryConfiguration	m_configuration The gallery configuration.
protected CmsCroppingParamBean	m_croppingParam The scale parameters from popup.
protected com.google.gwt.user.client.ui.Label	m_fader The fading element.
protected com.google.gwt.dom.client.DivElement	m_fieldBox The DIV carrying the input field.
protected com.google.gwt.dom.client.DivElement	m_imagePreview The image preview element.
protected com.google.gwt.user.client.ui.HTMLPanel	m_main The main panel.
protected CmsPushButton	m_opener The button to to open the selection.
protected CmsGalleryPopup	m_popup The gallery pop-up.
protected com.google.gwt.user.client.ui.FlowPanel	m_resourceInfoPanel The resource info panel.
protected CmsSimpleTextBox	m_textbox The textbox containing the currently selected path.
protected CmsUploadButton	m_uploadButton The upload button.
protected com.google.gwt.dom.client.Element	m_uploadDropZone The upload drop zone.
static java.lang.String	WIDGET_TYPE The widget type.

从类继承的字段 com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

构造器概要

构造器

构造器和说明
CmsGalleryField(I_CmsGalleryConfiguration configuration, boolean allowUploads) Constructs a new gallery widget.

方法概要

方法

限定符和类型	方法和说明
void	addFieldStyleName(java.lang.String styleName) Adds a style name to the DIV carrying the input field.
com.google.gwt.event.shared.HandlerRegistration	addFocusHandler(com.google.gwt.event.dom.client.FocusHandler handler)
com.google.gwt.event.shared.HandlerRegistration	addResizeHandler(com.google.gwt.event.logical.shared.ResizeHandler handler)
protected void	addToMain(com.google.gwt.user.client.ui.IsWidget widget) Adds a widget to the main panel.
com.google.gwt.event.shared.HandlerRegistration	addValueChangeHandler(com.google.gwt.event.logical.shared.ValueChangeHandler<java.lang.String> handler)
protected void	fireChange(boolean force) Fires the value change event if the value has changed.
protected void	fireResize() Fires the resize event for this widget.
java.lang.String	getApparentValue() Returns the "apparent value", i.e. either the real value if available, or else the ghost value if available, or null otherwise.
protected java.lang.String	getCurrentElement() Returns the currently set resource path.
I_CmsFormWidget.FieldType	getFieldType() Returns the type of data this widget produces.
java.lang.Object	getFormValue() Gets the selected/entered value from the widget.
java.lang.String	getFormValueAsString() Gets the current value of the widget as a string.
protected I_CmsGalleryServiceAsync	getGalleryService() Returns the gallery service instance.
CmsGalleryPopup	getPopup() Returns the gallery popup.
static void	initClass() Initializes this class.
boolean	isEnabled() Returns true if this widget is enabled.
protected void	onFocusTextbox(com.google.gwt.event.dom.client.FocusEvent event) Handles the focus event on the opener.
protected void	openGalleryDialog() Internal method which opens the gallery dialog.
protected boolean	removeFromMain(com.google.gwt.user.client.ui.IsWidget widget) Removes the given widget from the main panel.
void	reset() Resets the widget to its default state.
void	setAutoHideParent(I_CmsAutoHider autoHideParent) Call this when auto hiding parents are shown.
void	setDropZoneElement(com.google.gwt.dom.client.Element dropZone) Sets the upload drop zone element.
void	setEnabled(boolean enabled) Enables or disables the widget.
void	setErrorMessage(java.lang.String errorMessage) Sets the error message for this widget.
void	setFormValueAsString(java.lang.String value) Sets the current value of the widget as a string.
void	setGalleryOpenerTitle(java.lang.String openerTitle) Sets the gallery opener button title.
void	setHasImage(boolean hasImage) Sets the has image flag.
protected void	setImagePreview(java.lang.String imagePath) Sets the image preview.
void	setName(java.lang.String name) Sets the name of the input field.
protected void	setValue(java.lang.String value, boolean fireEvent) Sets the widget value.
protected void	setValueFromGallery(java.lang.String resourcePath, CmsUUID structureId, CmsCroppingParamBean croppingParameter) Sets the widget value.
protected void	updateUploadTarget(java.lang.String uploadTarget) Updates the upload target folder path.

从类继承的方法 com.google.gwt.user.client.ui.Composite

claimElement, getWidget, initializeClaimedElement, initWidget, isAttached, onAttach, onBrowserEvent, onDetach, render, render, resolvePotentialElement, setWidget

从类继承的方法 com.google.gwt.user.client.ui.Widget

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getHandlerCount, getLayoutData, getParent, isOrWasAttached, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents

从类继承的方法 com.google.gwt.user.client.ui.UIObject

addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, getTitle, isVisible, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, setElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, sinkBitlessEvent, toString, unsinkEvents

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

从接口继承的方法 com.google.gwt.event.shared.HasHandlers

fireEvent

字段详细资料

WIDGET_TYPE

public static final java.lang.String WIDGET_TYPE

The widget type.

另请参阅:

常量字段值

m_configuration

protected I_CmsGalleryConfiguration m_configuration

The gallery configuration.

m_croppingParam

protected CmsCroppingParamBean m_croppingParam

The scale parameters from popup.

m_fader

@UiField
protected com.google.gwt.user.client.ui.Label m_fader

The fading element.

m_fieldBox

@UiField
protected com.google.gwt.dom.client.DivElement m_fieldBox

The DIV carrying the input field.

m_imagePreview

@UiField
protected com.google.gwt.dom.client.DivElement m_imagePreview

The image preview element.

m_main

protected com.google.gwt.user.client.ui.HTMLPanel m_main

The main panel.

m_opener

@UiField
protected CmsPushButton m_opener

The button to to open the selection.

m_popup

protected CmsGalleryPopup m_popup

The gallery pop-up.

m_resourceInfoPanel

@UiField
protected com.google.gwt.user.client.ui.FlowPanel m_resourceInfoPanel

The resource info panel.

m_textbox

@UiField
protected CmsSimpleTextBox m_textbox

The textbox containing the currently selected path.

m_uploadButton

@UiField(provided=true)
protected CmsUploadButton m_uploadButton

The upload button.

m_uploadDropZone

protected com.google.gwt.dom.client.Element m_uploadDropZone

The upload drop zone.

构造器详细资料

CmsGalleryField

public CmsGalleryField(I_CmsGalleryConfiguration configuration,
               boolean allowUploads)

Constructs a new gallery widget.

参数:

configuration - the gallery configuration

allowUploads - states if the upload button should be enabled for this widget

方法详细资料

initClass

public static void initClass()

Initializes this class.

addFieldStyleName

public void addFieldStyleName(java.lang.String styleName)

Adds a style name to the DIV carrying the input field.

参数:

styleName - the style name to add

addFocusHandler

public com.google.gwt.event.shared.HandlerRegistration addFocusHandler(com.google.gwt.event.dom.client.FocusHandler handler)

指定者:

addFocusHandler 在接口中 com.google.gwt.event.dom.client.HasFocusHandlers

另请参阅:

HasFocusHandlers.addFocusHandler(com.google.gwt.event.dom.client.FocusHandler)

addResizeHandler

public com.google.gwt.event.shared.HandlerRegistration addResizeHandler(com.google.gwt.event.logical.shared.ResizeHandler handler)

指定者:

addResizeHandler 在接口中 com.google.gwt.event.logical.shared.HasResizeHandlers

另请参阅:

HasResizeHandlers.addResizeHandler(com.google.gwt.event.logical.shared.ResizeHandler)

addValueChangeHandler

public com.google.gwt.event.shared.HandlerRegistration addValueChangeHandler(com.google.gwt.event.logical.shared.ValueChangeHandler<java.lang.String> handler)

指定者:

addValueChangeHandler 在接口中 com.google.gwt.event.logical.shared.HasValueChangeHandlers<java.lang.String>

另请参阅:

HasValueChangeHandlers.addValueChangeHandler(com.google.gwt.event.logical.shared.ValueChangeHandler)

getApparentValue

public java.lang.String getApparentValue()

从接口复制的说明: I_CmsFormWidget

Returns the "apparent value", i.e. either the real value if available, or else the ghost value if available, or null otherwise.

指定者:

getApparentValue 在接口中 I_CmsFormWidget

返回:

the apparent value

另请参阅:

I_CmsFormWidget.getApparentValue()

getFieldType

public I_CmsFormWidget.FieldType getFieldType()

从接口复制的说明: I_CmsFormWidget

Returns the type of data this widget produces.

指定者:

getFieldType 在接口中 I_CmsFormWidget

返回:

the data type

另请参阅:

I_CmsFormWidget.getFieldType()

getFormValue

public java.lang.Object getFormValue()

从接口复制的说明: I_CmsFormWidget

Gets the selected/entered value from the widget.

指定者:

getFormValue 在接口中 I_CmsFormWidget

返回:

the value

另请参阅:

I_CmsFormWidget.getFormValue()

getFormValueAsString

public java.lang.String getFormValueAsString()

从接口复制的说明: I_CmsFormWidget

Gets the current value of the widget as a string.

指定者:

getFormValueAsString 在接口中 I_CmsFormWidget

返回:

the current value of the widget

另请参阅:

I_CmsFormWidget.getFormValueAsString()

getPopup

public CmsGalleryPopup getPopup()

Returns the gallery popup.

返回:

the gallery popup

isEnabled

public boolean isEnabled()

从接口复制的说明: I_CmsFormWidget

Returns true if this widget is enabled.

指定者:

isEnabled 在接口中 I_CmsFormWidget

返回:

true if this widget is enabled

另请参阅:

I_CmsFormWidget.isEnabled()

reset

public void reset()

从接口复制的说明: I_CmsFormWidget

Resets the widget to its default state.

指定者:

reset 在接口中 I_CmsFormWidget

另请参阅:

I_CmsFormWidget.reset()

setAutoHideParent

public void setAutoHideParent(I_CmsAutoHider autoHideParent)

从接口复制的说明: I_CmsFormWidget

Call this when auto hiding parents are shown.

指定者:

setAutoHideParent 在接口中 I_CmsFormWidget

参数:

autoHideParent - the auto hide parent

另请参阅:

I_CmsFormWidget.setAutoHideParent(org.opencms.gwt.client.ui.I_CmsAutoHider)

setDropZoneElement

public void setDropZoneElement(com.google.gwt.dom.client.Element dropZone)

Sets the upload drop zone element.

参数:

dropZone - the upload drop zone element

setEnabled

public void setEnabled(boolean enabled)

从接口复制的说明: I_CmsFormWidget

Enables or disables the widget.

指定者:

setEnabled 在接口中 I_CmsFormWidget

参数:

enabled - if true, the widget will be enabled, else disabled

另请参阅:

I_CmsFormWidget.setEnabled(boolean)

setErrorMessage

public void setErrorMessage(java.lang.String errorMessage)

从接口复制的说明: I_CmsFormWidget

Sets the error message for this widget.

If the error message is null, no error message will be displayed.

指定者:

setErrorMessage 在接口中 I_CmsFormWidget

参数:

errorMessage - an error message or null

另请参阅:

I_CmsFormWidget.setErrorMessage(java.lang.String)

setFormValueAsString

public void setFormValueAsString(java.lang.String value)

从接口复制的说明: I_CmsFormWidget

Sets the current value of the widget as a string.

指定者:

setFormValueAsString 在接口中 I_CmsFormWidget

参数:

value - the new value of the widget

另请参阅:

I_CmsFormWidget.setFormValueAsString(java.lang.String)

setGalleryOpenerTitle

public void setGalleryOpenerTitle(java.lang.String openerTitle)

Sets the gallery opener button title.

参数:

openerTitle - the gallery opener button title

setHasImage

public void setHasImage(boolean hasImage)

Sets the has image flag.

参数:

hasImage - the has image flag

setName

public void setName(java.lang.String name)

Sets the name of the input field.

参数:

name - of the input field

addToMain

protected void addToMain(com.google.gwt.user.client.ui.IsWidget widget)

Adds a widget to the main panel.

参数:

widget - the widget to add

fireChange

protected void fireChange(boolean force)

Fires the value change event if the value has changed.

参数:

force - true to force firing the event in any case

fireResize

protected void fireResize()

Fires the resize event for this widget.

getCurrentElement

protected java.lang.String getCurrentElement()

Returns the currently set resource path.

返回:

the currently set resource path

getGalleryService

protected I_CmsGalleryServiceAsync getGalleryService()

Returns the gallery service instance.

返回:

the gallery service instance

onFocusTextbox

@UiHandler(value="m_textbox")
protected void onFocusTextbox(com.google.gwt.event.dom.client.FocusEvent event)

Handles the focus event on the opener.

参数:

event -

openGalleryDialog

protected void openGalleryDialog()

Internal method which opens the gallery dialog.

removeFromMain

protected boolean removeFromMain(com.google.gwt.user.client.ui.IsWidget widget)

Removes the given widget from the main panel.

参数:

widget - the widget to remove

返回:

true if the widget was a child of the main panel

setImagePreview

protected void setImagePreview(java.lang.String imagePath)

Sets the image preview.

参数:

imagePath - the image path

setValue

protected void setValue(java.lang.String value,
            boolean fireEvent)

Sets the widget value.

参数:

value - the value to set

fireEvent - if the change event should be fired

setValueFromGallery

protected void setValueFromGallery(java.lang.String resourcePath,
                       CmsUUID structureId,
                       CmsCroppingParamBean croppingParameter)

Sets the widget value. To be called from the gallery dialog.

参数:

resourcePath - the selected resource path

structureId - the resource structure id

croppingParameter - the selected cropping

updateUploadTarget

protected void updateUploadTarget(java.lang.String uploadTarget)

Updates the upload target folder path.

参数:

uploadTarget - the upload target folder