org.opencms.gwt.client.ui

类 CmsListItemWidget

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.CmsListItemWidget

所有已实现的接口:

com.google.gwt.event.dom.client.HasClickHandlers, com.google.gwt.event.dom.client.HasDoubleClickHandlers, com.google.gwt.event.dom.client.HasMouseOutHandlers, com.google.gwt.event.dom.client.HasMouseOverHandlers, com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.logical.shared.HasCloseHandlers<CmsListItemWidget>, com.google.gwt.event.logical.shared.HasOpenHandlers<CmsListItemWidget>, 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_CmsTruncable

直接已知子类:

CmsInfoLoadingListItemWidget, CmsResultItemWidget

public class CmsListItemWidget
extends com.google.gwt.user.client.ui.Composite
implements com.google.gwt.event.logical.shared.HasOpenHandlers<CmsListItemWidget>, com.google.gwt.event.logical.shared.HasCloseHandlers<CmsListItemWidget>, com.google.gwt.event.dom.client.HasMouseOutHandlers, com.google.gwt.event.dom.client.HasClickHandlers, com.google.gwt.event.dom.client.HasDoubleClickHandlers, com.google.gwt.event.dom.client.HasMouseOverHandlers, I_CmsTruncable

Provides a UI list item.

从以下版本开始:

8.0.0

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	CmsListItemWidget.AdditionalInfoItem Additional info item HTML.
static class	CmsListItemWidget.Background Background color values.
protected static interface	CmsListItemWidget.I_CmsListItemWidgetUiBinder
static interface	CmsListItemWidget.I_CmsTitleEditHandler The interface for handling edits of the title field.

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

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

字段概要

字段

限定符和类型	字段和说明
protected com.google.gwt.user.client.ui.FlowPanel	m_additionalInfo DIV for additional item info.
protected com.google.gwt.user.client.ui.FlowPanel	m_buttonPanel Panel to hold buttons.
protected com.google.gwt.user.client.ui.FlowPanel	m_contentPanel Panel to hold the content.
protected java.util.List<com.google.gwt.event.dom.client.ClickHandler>	m_iconClickHandlers A list of click handlers for the main icon.
protected com.google.gwt.user.client.ui.SimplePanel	m_iconPanel The DIV showing the list icon.
protected CmsPushButton	m_openClose The open-close button for the additional info.
protected com.google.gwt.user.client.ui.InlineLabel	m_shortExtraInfoLabel A label which is optionally displayed after the subtitle.
protected CmsLabel	m_subtitle Sub title label.
protected CmsLabel	m_title Title label.
protected com.google.gwt.user.client.ui.FlowPanel	m_titleBox Container for the title.
protected com.google.gwt.user.client.ui.FlowPanel	m_titleRow The title row, holding the title and the open-close button for the additional info.
protected static java.lang.String	OPENCLASS The CSS class to set the additional info open.

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

DEBUG_ID_PREFIX

构造器概要

构造器

构造器和说明
CmsListItemWidget(CmsListInfoBean infoBean) Constructor.

方法概要

方法

限定符和类型	方法和说明
void	addAdditionalInfo(CmsAdditionalInfoBean additionalInfo) Adds an additional info item to the list.
void	addButton(com.google.gwt.user.client.ui.Widget w) Adds a widget to the button panel.
void	addButtonToFront(com.google.gwt.user.client.ui.Widget w) Adds a widget to the front of the button panel.
com.google.gwt.event.shared.HandlerRegistration	addClickHandler(com.google.gwt.event.dom.client.ClickHandler handler)
com.google.gwt.event.shared.HandlerRegistration	addCloseHandler(com.google.gwt.event.logical.shared.CloseHandler<CmsListItemWidget> handler)
com.google.gwt.event.shared.HandlerRegistration	addDoubleClickHandler(com.google.gwt.event.dom.client.DoubleClickHandler handler)
com.google.gwt.event.shared.HandlerRegistration	addIconClickHandler(com.google.gwt.event.dom.client.ClickHandler handler) Adds a mouse click handler to the icon panel.
com.google.gwt.event.shared.HandlerRegistration	addMouseOutHandler(com.google.gwt.event.dom.client.MouseOutHandler handler)
com.google.gwt.event.shared.HandlerRegistration	addMouseOverHandler(com.google.gwt.event.dom.client.MouseOverHandler handler)
com.google.gwt.event.shared.HandlerRegistration	addOpenHandler(com.google.gwt.event.logical.shared.OpenHandler<CmsListItemWidget> handler)
void	addSubtitleStyleName(java.lang.String styleName) Adds a style name to the subtitle label.
void	addTitleStyleName(java.lang.String styleName) Adds a style name to the title label.
void	clearIcon() Hides the icon of the list item widget.
protected void	editTitle() Internal method which is called when the user clicks on an editable title field.
protected void	ensureOpenCloseAdditionalInfo() Ensures the open close button for the additional info list is present.
void	forceMouseOut() Forces mouse out on self and contained buttons.
com.google.gwt.user.client.ui.Widget	getButton(int index) Returns the button at the given position.
int	getButtonCount() Returns the number of buttons.
com.google.gwt.user.client.ui.FlowPanel	getButtonPanel() Returns the button panel.
com.google.gwt.user.client.ui.FlowPanel	getContentPanel() Returns the content panel.
com.google.gwt.user.client.ui.InlineLabel	getShortExtraInfoLabel() Returns the label after the subtitle.
java.lang.String	getSubtitleLabel() Returns the subtitle label.
java.lang.String	getTitleLabel() Returns the title label text.
CmsLabel	getTitleWidget() Gets the title widget.
boolean	hasAdditionalInfo() Returns if additional info items are present.
protected void	init(CmsListInfoBean infoBean) Constructor.
protected void	initAdditionalInfo(CmsListInfoBean infoBean) Initializes the additional info.
protected void	onEditTitleTextBox(com.google.gwt.user.client.ui.TextBox box) Internal method which is called when the user has finished editing the title.
void	reInitAdditionalInfo(CmsListInfoBean infoBean) Re-initializes the additional infos.
void	removeButton(com.google.gwt.user.client.ui.Widget w) Removes a widget from the button panel.
void	removeMouseHandlers() Removes all registered mouse event handlers including the context menu handler.
void	removeSubtitleStyleName(java.lang.String styleName) Removes a style name from the subtitle label.
void	removeTitleStyleName(java.lang.String styleName) Removes a style name from the title label.
void	setAdditionalInfoValue(int index, java.lang.String label) Sets the additional info value label at the given position.
void	setAdditionalInfoVisible(boolean visible) Sets the additional info visible if present.
void	setBackground(CmsListItemWidget.Background background) Sets the background color.
void	setExtraInfo(java.lang.String text) Sets the extra info text, and hides or displays the extra info label depending on whether the text is null or not null.
void	setIcon(com.google.gwt.user.client.ui.Image image) Sets the icon of this item.
void	setIcon(java.lang.String iconClasses) Sets the icon for this item using the given CSS classes.
void	setIconCursor(com.google.gwt.dom.client.Style.Cursor cursor) Sets the cursor for the icon.
void	setIconTitle(java.lang.String title) Sets the icon title.
void	setLockIcon(CmsListInfoBean.LockIcon icon, java.lang.String iconTitle) Sets the lock icon.
void	setStateIcon(CmsListInfoBean.StateIcon icon) Sets the state icon.
void	setSubtitleLabel(java.lang.String label) Sets the subtitle label text.
void	setTitleEditable(boolean editable) Enables or disabled editing of the title field.
void	setTitleEditHandler(CmsListItemWidget.I_CmsTitleEditHandler handler) Sets the handler for editing the list item widget's title.
void	setTitleLabel(java.lang.String label) Sets the title label text.
void	setTopRightIcon(java.lang.String iconClass, java.lang.String title) Sets the icon in the top right corner and its title.
void	setUnselectable() Makes the content of the list info box unselectable.
void	truncate(java.lang.String textMetricsPrefix, int widgetWidth) Truncates long text and sets the original text to the title attribute.
void	updateTruncation() Updates the truncation of labels if needed.

从类继承的方法 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

字段详细资料

OPENCLASS

protected static final java.lang.String OPENCLASS

The CSS class to set the additional info open.

m_additionalInfo

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

DIV for additional item info.

m_buttonPanel

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

Panel to hold buttons.

m_contentPanel

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

Panel to hold the content.

m_iconClickHandlers

protected java.util.List<com.google.gwt.event.dom.client.ClickHandler> m_iconClickHandlers

A list of click handlers for the main icon.

m_iconPanel

@UiField
protected com.google.gwt.user.client.ui.SimplePanel m_iconPanel

The DIV showing the list icon.

m_openClose

protected CmsPushButton m_openClose

The open-close button for the additional info.

m_shortExtraInfoLabel

protected com.google.gwt.user.client.ui.InlineLabel m_shortExtraInfoLabel

A label which is optionally displayed after the subtitle.

m_subtitle

@UiField
protected CmsLabel m_subtitle

Sub title label.

m_title

@UiField
protected CmsLabel m_title

Title label.

m_titleBox

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

Container for the title.

m_titleRow

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

The title row, holding the title and the open-close button for the additional info.

构造器详细资料

CmsListItemWidget

public CmsListItemWidget(CmsListInfoBean infoBean)

Constructor. Using a 'li'-tag as default root element.

参数:

infoBean - bean holding the item information

方法详细资料

addAdditionalInfo

public void addAdditionalInfo(CmsAdditionalInfoBean additionalInfo)

Adds an additional info item to the list.

参数:

additionalInfo - the additional info to display

addButton

public void addButton(com.google.gwt.user.client.ui.Widget w)

Adds a widget to the button panel.

参数:

w - the widget to add

addButtonToFront

public void addButtonToFront(com.google.gwt.user.client.ui.Widget w)

Adds a widget to the front of the button panel.

参数:

w - the widget to add

addClickHandler

public com.google.gwt.event.shared.HandlerRegistration addClickHandler(com.google.gwt.event.dom.client.ClickHandler handler)

指定者:

addClickHandler 在接口中 com.google.gwt.event.dom.client.HasClickHandlers

另请参阅:

HasClickHandlers.addClickHandler(ClickHandler)

addCloseHandler

public com.google.gwt.event.shared.HandlerRegistration addCloseHandler(com.google.gwt.event.logical.shared.CloseHandler<CmsListItemWidget> handler)

指定者:

addCloseHandler 在接口中 com.google.gwt.event.logical.shared.HasCloseHandlers<CmsListItemWidget>

另请参阅:

HasCloseHandlers.addCloseHandler(com.google.gwt.event.logical.shared.CloseHandler)

addDoubleClickHandler

public com.google.gwt.event.shared.HandlerRegistration addDoubleClickHandler(com.google.gwt.event.dom.client.DoubleClickHandler handler)

指定者:

addDoubleClickHandler 在接口中 com.google.gwt.event.dom.client.HasDoubleClickHandlers

另请参阅:

HasDoubleClickHandlers.addDoubleClickHandler(com.google.gwt.event.dom.client.DoubleClickHandler)

addIconClickHandler

public com.google.gwt.event.shared.HandlerRegistration addIconClickHandler(com.google.gwt.event.dom.client.ClickHandler handler)

Adds a mouse click handler to the icon panel.

参数:

handler - the click handler

返回:

the handler registration

addMouseOutHandler

public com.google.gwt.event.shared.HandlerRegistration addMouseOutHandler(com.google.gwt.event.dom.client.MouseOutHandler handler)

指定者:

addMouseOutHandler 在接口中 com.google.gwt.event.dom.client.HasMouseOutHandlers

另请参阅:

HasMouseOutHandlers.addMouseOutHandler(com.google.gwt.event.dom.client.MouseOutHandler)

addMouseOverHandler

public com.google.gwt.event.shared.HandlerRegistration addMouseOverHandler(com.google.gwt.event.dom.client.MouseOverHandler handler)

指定者:

addMouseOverHandler 在接口中 com.google.gwt.event.dom.client.HasMouseOverHandlers

另请参阅:

HasMouseOverHandlers.addMouseOverHandler(com.google.gwt.event.dom.client.MouseOverHandler)

addOpenHandler

public com.google.gwt.event.shared.HandlerRegistration addOpenHandler(com.google.gwt.event.logical.shared.OpenHandler<CmsListItemWidget> handler)

指定者:

addOpenHandler 在接口中 com.google.gwt.event.logical.shared.HasOpenHandlers<CmsListItemWidget>

另请参阅:

HasOpenHandlers.addOpenHandler(com.google.gwt.event.logical.shared.OpenHandler)

addSubtitleStyleName

public void addSubtitleStyleName(java.lang.String styleName)

Adds a style name to the subtitle label.

参数:

styleName - the style name to add

addTitleStyleName

public void addTitleStyleName(java.lang.String styleName)

Adds a style name to the title label.

参数:

styleName - the style name to add

clearIcon

public void clearIcon()

Hides the icon of the list item widget.

forceMouseOut

public void forceMouseOut()

Forces mouse out on self and contained buttons.

getButton

public com.google.gwt.user.client.ui.Widget getButton(int index)

Returns the button at the given position.

参数:

index - the button index

返回:

the button at the given position

getButtonCount

public int getButtonCount()

Returns the number of buttons.

返回:

the number of buttons

getButtonPanel

public com.google.gwt.user.client.ui.FlowPanel getButtonPanel()

Returns the button panel.

返回:

the button panel

getContentPanel

public com.google.gwt.user.client.ui.FlowPanel getContentPanel()

Returns the content panel.

返回:

the content panel

getShortExtraInfoLabel

public com.google.gwt.user.client.ui.InlineLabel getShortExtraInfoLabel()

Returns the label after the subtitle.

返回:

the label after the subtitle

getSubtitleLabel

public java.lang.String getSubtitleLabel()

Returns the subtitle label.

返回:

the subtitle label

getTitleLabel

public java.lang.String getTitleLabel()

Returns the title label text.

返回:

the title label text

getTitleWidget

public CmsLabel getTitleWidget()

Gets the title widget.

返回:

the title widget

hasAdditionalInfo

public boolean hasAdditionalInfo()

Returns if additional info items are present.

返回:

true if additional info items are present

reInitAdditionalInfo

public void reInitAdditionalInfo(CmsListInfoBean infoBean)

Re-initializes the additional infos.

参数:

infoBean - the info bean

removeButton

public void removeButton(com.google.gwt.user.client.ui.Widget w)

Removes a widget from the button panel.

参数:

w - the widget to remove

removeMouseHandlers

public void removeMouseHandlers()

Removes all registered mouse event handlers including the context menu handler.

removeSubtitleStyleName

public void removeSubtitleStyleName(java.lang.String styleName)

Removes a style name from the subtitle label.

参数:

styleName - the style name to add

removeTitleStyleName

public void removeTitleStyleName(java.lang.String styleName)

Removes a style name from the title label.

参数:

styleName - the style name to add

setAdditionalInfoValue

public void setAdditionalInfoValue(int index,
                          java.lang.String label)

Sets the additional info value label at the given position.

参数:

index - the additional info index

label - the new value to set

setAdditionalInfoVisible

public void setAdditionalInfoVisible(boolean visible)

Sets the additional info visible if present.

参数:

visible - true to show, false to hide

setBackground

public void setBackground(CmsListItemWidget.Background background)

Sets the background color.

参数:

background - the color

setExtraInfo

public void setExtraInfo(java.lang.String text)

Sets the extra info text, and hides or displays the extra info label depending on whether the text is null or not null.

参数:

text - the text to put into the subtitle suffix

setIcon

public void setIcon(com.google.gwt.user.client.ui.Image image)

Sets the icon of this item.

参数:

image - the image to use as icon

setIcon

public void setIcon(java.lang.String iconClasses)

Sets the icon for this item using the given CSS classes.

参数:

iconClasses - the CSS classes

setIconCursor

public void setIconCursor(com.google.gwt.dom.client.Style.Cursor cursor)

Sets the cursor for the icon.

参数:

cursor - the cursor for the icon

setIconTitle

public void setIconTitle(java.lang.String title)

Sets the icon title.

参数:

title - the new icon title

setLockIcon

public void setLockIcon(CmsListInfoBean.LockIcon icon,
               java.lang.String iconTitle)

Sets the lock icon.

参数:

icon - the icon to use

iconTitle - the icon title

setStateIcon

public void setStateIcon(CmsListInfoBean.StateIcon icon)

Sets the state icon.

The state icon indicates if a resource is exported, secure, etc.

参数:

icon - the state icon

setSubtitleLabel

public void setSubtitleLabel(java.lang.String label)

Sets the subtitle label text.

参数:

label - the new subtitle to set

setTitleEditable

public void setTitleEditable(boolean editable)

Enables or disabled editing of the title field.

参数:

editable - if true, makes the title field editable

setTitleEditHandler

public void setTitleEditHandler(CmsListItemWidget.I_CmsTitleEditHandler handler)

Sets the handler for editing the list item widget's title.

参数:

handler - the new title editing handler

setTitleLabel

public void setTitleLabel(java.lang.String label)

Sets the title label text.

参数:

label - the new title to set

setTopRightIcon

public void setTopRightIcon(java.lang.String iconClass,
                   java.lang.String title)

Sets the icon in the top right corner and its title.

参数:

iconClass - the CSS class for the icon

title - the value for the title attribute of the icon

setUnselectable

public void setUnselectable()

Makes the content of the list info box unselectable.

truncate

public void truncate(java.lang.String textMetricsPrefix,
            int widgetWidth)

从接口复制的说明: I_CmsTruncable

Truncates long text and sets the original text to the title attribute.

指定者:

truncate 在接口中 I_CmsTruncable

参数:

textMetricsPrefix - the key identifying the text metrics to use

widgetWidth - the width to use in pixels

另请参阅:

I_CmsTruncable.truncate(java.lang.String, int)

updateTruncation

public void updateTruncation()

Updates the truncation of labels if needed.

Use after changing any text on the widget.

editTitle

protected void editTitle()

Internal method which is called when the user clicks on an editable title field.

ensureOpenCloseAdditionalInfo

protected void ensureOpenCloseAdditionalInfo()

Ensures the open close button for the additional info list is present.

init

protected void init(CmsListInfoBean infoBean)

Constructor.

参数:

infoBean - bean holding the item information

initAdditionalInfo

protected void initAdditionalInfo(CmsListInfoBean infoBean)

Initializes the additional info.

参数:

infoBean - the info bean

onEditTitleTextBox

protected void onEditTitleTextBox(com.google.gwt.user.client.ui.TextBox box)

Internal method which is called when the user has finished editing the title.

参数:

box - the text box which has been edited