org.opencms.gwt.client.ui.input.upload

类 CmsUploadButton

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.gwt.client.ui.input.upload.CmsUploadButton

所有已实现的接口:

com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.HasHorizontalAlignment, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.IsRenderable, com.google.gwt.user.client.ui.IsWidget

public class CmsUploadButton
extends com.google.gwt.user.client.ui.Composite
implements com.google.gwt.user.client.ui.HasHorizontalAlignment

Provides a upload button.

从以下版本开始:

8.0.0

嵌套类概要

嵌套类

限定符和类型	类和说明
protected static interface	CmsUploadButton.I_CmsUploadButtonUiBinder The ui-binder interface.

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

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

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

com.google.gwt.user.client.ui.HasHorizontalAlignment.AutoHorizontalAlignmentConstant, com.google.gwt.user.client.ui.HasHorizontalAlignment.HorizontalAlignmentConstant

字段概要

字段

限定符和类型	字段和说明
protected com.google.gwt.user.client.ui.HTML	m_buttonFace The button face.
protected CmsFlowPanel	m_main The main panel.

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

DEBUG_ID_PREFIX

从接口继承的字段 com.google.gwt.user.client.ui.HasHorizontalAlignment

ALIGN_CENTER, ALIGN_DEFAULT, ALIGN_JUSTIFY, ALIGN_LEFT, ALIGN_LOCALE_END, ALIGN_LOCALE_START, ALIGN_RIGHT

构造器概要

构造器

构造器和说明
CmsUploadButton(I_CmsUploadButtonHandler buttonHandler) The default constructor.

方法概要

方法

限定符和类型	方法和说明
CmsFileInput	createFileInput() Creates and adds a file input.
void	disable(java.lang.String disabledReason) Disables the button and changes the button title attribute to the disabled reason.
void	enable() Enables the button, switching the button title attribute from the disabled reason to the original title.
static java.lang.String	formatBytes(long filesize) Formats a given bytes value (file size).
I_CmsUploadButtonHandler	getButtonHandler() Gets the upload button handler instance for this button.
protected java.lang.String	getFaceHtml(java.lang.String text, java.lang.String imageClass) Convenience method to assemble the HTML to use for a button face.
com.google.gwt.user.client.ui.HasHorizontalAlignment.HorizontalAlignmentConstant	getHorizontalAlignment() This is the alignment of the text in reference to the image, possible values are left or right.
java.lang.String	getImageClass() Returns the master image class.
I_CmsButton.Size	getSize() Returns the size.
java.lang.String	getText() Returns the text.
java.lang.String	getTitle() Returns the title.
protected void	handleMouseOut(com.google.gwt.event.dom.client.MouseOutEvent event) Handles the mouse over event on the main panel.
protected void	handleMouseOver(com.google.gwt.event.dom.client.MouseOverEvent event) Handles the mouse over event on the main panel.
boolean	isEnabled() Returns if the upload button is enabled.
boolean	isUseMinWidth() Checks if the button is constraint to a minimal width.
void	reinitButton(I_CmsUploadButtonHandler buttonHandler) Reinitializes the button with a new button handler.
void	setButtonStyle(I_CmsButton.ButtonStyle style, I_CmsButton.ButtonColor color) Sets the button style.
void	setHorizontalAlignment(com.google.gwt.user.client.ui.HasHorizontalAlignment.HorizontalAlignmentConstant align) This is the alignment of the text in reference to the image, possible values are left or right.
void	setImageClass(java.lang.String imageClass) Sets the master image class.
void	setSize(I_CmsButton.Size size) Sets the size.
void	setText(java.lang.String text) Sets the text.
void	setTitle(java.lang.String title)
void	setUpFace(java.lang.String text, java.lang.String imageClass) Sets the up face text and image.
void	setUseMinWidth(boolean useMinWidth) Tells the button to use a minimal width.

从类继承的方法 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, isVisible, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, setElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, setVisible, setWidth, sinkBitlessEvent, toString, unsinkEvents

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

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

字段详细资料

m_buttonFace

@UiField
protected com.google.gwt.user.client.ui.HTML m_buttonFace

The button face.

m_main

@UiField
protected CmsFlowPanel m_main

The main panel.

构造器详细资料

CmsUploadButton

public CmsUploadButton(I_CmsUploadButtonHandler buttonHandler)

The default constructor.

Creates a new upload button. This upload button opens a new OS file selector on click.

On change the button handler passed into the constructor is notified.

参数:

buttonHandler - the buttonHandler

方法详细资料

formatBytes

public static java.lang.String formatBytes(long filesize)

Formats a given bytes value (file size).

参数:

filesize - the file size to format

返回:

the formated file size in KB

createFileInput

public CmsFileInput createFileInput()

Creates and adds a file input.

返回:

returns the previous file input widget

disable

public void disable(java.lang.String disabledReason)

Disables the button and changes the button title attribute to the disabled reason.

参数:

disabledReason - the disabled reason

enable

public void enable()

Enables the button, switching the button title attribute from the disabled reason to the original title.

getButtonHandler

public I_CmsUploadButtonHandler getButtonHandler()

Gets the upload button handler instance for this button.

返回:

the upload button handler

getHorizontalAlignment

public com.google.gwt.user.client.ui.HasHorizontalAlignment.HorizontalAlignmentConstant getHorizontalAlignment()

This is the alignment of the text in reference to the image, possible values are left or right.

指定者:

getHorizontalAlignment 在接口中 com.google.gwt.user.client.ui.HasHorizontalAlignment

另请参阅:

HasHorizontalAlignment.getHorizontalAlignment()

getImageClass

public java.lang.String getImageClass()

Returns the master image class.

返回:

the master image class

getSize

public I_CmsButton.Size getSize()

Returns the size.

返回:

the size

getText

public java.lang.String getText()

Returns the text.

返回:

the text

getTitle

public java.lang.String getTitle()

Returns the title.

覆盖:

getTitle 在类中 com.google.gwt.user.client.ui.UIObject

返回:

the title

isEnabled

public boolean isEnabled()

Returns if the upload button is enabled.

返回:

true if the upload button is enabled

isUseMinWidth

public boolean isUseMinWidth()

Checks if the button is constraint to a minimal width.

返回:

true if the button is constraint to a minimal width

reinitButton

public void reinitButton(I_CmsUploadButtonHandler buttonHandler)

Reinitializes the button with a new button handler.

参数:

buttonHandler - the button handler

setButtonStyle

public void setButtonStyle(I_CmsButton.ButtonStyle style,
                  I_CmsButton.ButtonColor color)

Sets the button style.

参数:

style - the style to set

color - the color to set

setHorizontalAlignment

public void setHorizontalAlignment(com.google.gwt.user.client.ui.HasHorizontalAlignment.HorizontalAlignmentConstant align)

This is the alignment of the text in reference to the image, possible values are left or right.

指定者:

setHorizontalAlignment 在接口中 com.google.gwt.user.client.ui.HasHorizontalAlignment

另请参阅:

HasHorizontalAlignment.setHorizontalAlignment(com.google.gwt.user.client.ui.HasHorizontalAlignment.HorizontalAlignmentConstant)

setImageClass

public void setImageClass(java.lang.String imageClass)

Sets the master image class.

参数:

imageClass - the master image class to set

setSize

public void setSize(I_CmsButton.Size size)

Sets the size.

参数:

size - the size to set

setText

public void setText(java.lang.String text)

Sets the text.

参数:

text - the text to set

setTitle

public void setTitle(java.lang.String title)

覆盖:

setTitle 在类中 com.google.gwt.user.client.ui.UIObject

另请参阅:

UIObject.setTitle(java.lang.String)

setUpFace

public void setUpFace(java.lang.String text,
             java.lang.String imageClass)

Sets the up face text and image.

参数:

text - the up face text to set, set to null to not show any

imageClass - the up face image class to use, set to null to not show any

setUseMinWidth

public void setUseMinWidth(boolean useMinWidth)

Tells the button to use a minimal width.

参数:

useMinWidth - true to use a minimal width

getFaceHtml

protected java.lang.String getFaceHtml(java.lang.String text,
                           java.lang.String imageClass)

Convenience method to assemble the HTML to use for a button face.

参数:

text - text the up face text to set, set to null to not show any

imageClass - the up face image class to use, set to null to not show any

返回:

the HTML

handleMouseOut

@UiHandler(value="m_main")
protected void handleMouseOut(com.google.gwt.event.dom.client.MouseOutEvent event)

Handles the mouse over event on the main panel.

参数:

event - the event

另请参阅:

MouseOutHandler.onMouseOut(com.google.gwt.event.dom.client.MouseOutEvent)

handleMouseOver

@UiHandler(value="m_main")
protected void handleMouseOver(com.google.gwt.event.dom.client.MouseOverEvent event)

Handles the mouse over event on the main panel.

参数:

event - the event

另请参阅:

MouseOverHandler.onMouseOver(com.google.gwt.event.dom.client.MouseOverEvent)