org.opencms.gwt.client.ui

类 CmsList<I extends I_CmsListItem>

java.lang.Object

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

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

com.google.gwt.user.client.ui.Panel

com.google.gwt.user.client.ui.ComplexPanel

org.opencms.gwt.client.ui.CmsList<I>

类型参数:

I - the specific list item implementation

所有已实现的接口:

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.HasVisibility, com.google.gwt.user.client.ui.HasWidgets, com.google.gwt.user.client.ui.HasWidgets.ForIsWidget, com.google.gwt.user.client.ui.IndexedPanel, com.google.gwt.user.client.ui.IndexedPanel.ForIsWidget, com.google.gwt.user.client.ui.IsWidget, java.lang.Iterable<com.google.gwt.user.client.ui.Widget>, I_CmsDropTarget, I_CmsTruncable

直接已知子类:

CmsTree

public class CmsList<I extends I_CmsListItem>
extends com.google.gwt.user.client.ui.ComplexPanel
implements I_CmsTruncable, I_CmsDropTarget

A very basic list implementation to hold CmsListItemWidget.

从以下版本开始:

8.0.0

嵌套类概要

从类继承的嵌套类/接口 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.IndexedPanel

com.google.gwt.user.client.ui.IndexedPanel.ForIsWidget

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

com.google.gwt.user.client.ui.HasWidgets.ForIsWidget

字段概要

字段

限定符和类型	字段和说明
protected CmsDNDHandler	m_dndHandler The drag'n drop handler.
protected com.google.gwt.dom.client.Element	m_placeholder The current place holder.
protected int	m_placeholderIndex The placeholder position index.

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

DEBUG_ID_PREFIX

构造器概要

构造器

构造器和说明
CmsList() Constructor.

方法概要

方法

限定符和类型	方法和说明
void	add(com.google.gwt.user.client.ui.Widget widget)
void	addItem(I item) Adds an item to the list.
protected void	changeId(I item, java.lang.String id) Changes the id for the given item.
boolean	checkPosition(int x, int y, CmsDNDHandler.Orientation orientation) Returns true if the given cursor position is over the drop target.
void	clearList() Clears the list.
CmsDNDHandler	getDnDHandler() Returns the drag'n drop handler.
I	getItem(int index) Returns the list item at the given position.
I	getItem(java.lang.String itemId) Returns the list item with the given id.
int	getItemPosition(I item) Returns the given item position.
int	getPlaceholderIndex() Returns the index of the placeholder or -1 if no placeholder is attached.
void	insert(com.google.gwt.user.client.ui.Widget widget, int position) Inserts the given widget at the given position.
void	insertItem(I item, int position) Inserts the given item at the given position.
void	insertPlaceholder(com.google.gwt.dom.client.Element placeholder, int x, int y, CmsDNDHandler.Orientation orientation) Inserts a new placeholder.
boolean	isDNDTakeAll() Returns if the list will always return true on check target requests within drag and drop.
boolean	isDropEnabled() Checks if dropping is enabled.
void	onDrop(I_CmsDraggable draggable) Executed on drop.
protected void	registerItem(I item) Registers the given item on this list.
boolean	remove(com.google.gwt.user.client.ui.Widget w)
I	removeItem(I item) Removes an item from the list.
I	removeItem(java.lang.String itemId) Removes an item from the list.
void	removePlaceholder() Removes the placeholder.
void	repositionPlaceholder(int x, int y, CmsDNDHandler.Orientation orientation) Repositions the placeholder.
void	setDNDHandler(CmsDNDHandler handler) Sets the drag'n drop handler.
void	setDNDTakeAll(boolean takeAll) Sets if the list will always return true on check target requests within drag and drop.
void	setDropEnabled(boolean enabled) Enables/disables dropping.
protected void	setPlaceholder(com.google.gwt.dom.client.Element placeholder) Sets the current drag'n drop place holder.
void	truncate(java.lang.String textMetricsPrefix, int widgetWidth) Truncates long text and sets the original text to the title attribute.

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

add, adjustIndex, checkIndexBoundsForAccess, checkIndexBoundsForInsertion, getChildren, getWidget, getWidgetCount, getWidgetIndex, getWidgetIndex, insert, insert, iterator, remove

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

add, adopt, adopt, clear, disown, doAttachChildren, doDetachChildren, orphan, remove

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

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, onAttach, onBrowserEvent, onDetach, 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, resolvePotentialElement, 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

从接口继承的方法 org.opencms.gwt.client.dnd.I_CmsDropTarget

getElement

字段详细资料

m_dndHandler

protected CmsDNDHandler m_dndHandler

The drag'n drop handler.

m_placeholder

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

The current place holder.

m_placeholderIndex

protected int m_placeholderIndex

The placeholder position index.

构造器详细资料

CmsList

public CmsList()

Constructor.

方法详细资料

add

public void add(com.google.gwt.user.client.ui.Widget widget)

指定者:

add 在接口中 com.google.gwt.user.client.ui.HasWidgets

覆盖:

add 在类中 com.google.gwt.user.client.ui.Panel

另请参阅:

Panel.add(com.google.gwt.user.client.ui.Widget)

addItem

public void addItem(I item)

Adds an item to the list.

参数:

item - the item to add

另请参阅:

add(Widget)

checkPosition

public boolean checkPosition(int x,
                    int y,
                    CmsDNDHandler.Orientation orientation)

从接口复制的说明: I_CmsDropTarget

Returns true if the given cursor position is over the drop target.

指定者:

checkPosition 在接口中 I_CmsDropTarget

参数:

x - the cursor client x position

y - the cursor client y position

orientation - the drag and drop orientation

返回:

true if the given cursor position is over the drop target

另请参阅:

org.opencms.gwt.client.dnd.I_CmsDropTarget#checkPosition(int, int, Orientation)

clearList

public void clearList()

Clears the list.

getDnDHandler

public CmsDNDHandler getDnDHandler()

Returns the drag'n drop handler.

返回:

the handler

getItem

public I getItem(int index)

Returns the list item at the given position.

参数:

index - the position

返回:

the list item

另请参阅:

ComplexPanel.getWidget(int)

getItem

public I getItem(java.lang.String itemId)

Returns the list item with the given id.

参数:

itemId - the id of the item to retrieve

返回:

the list item

另请参阅:

ComplexPanel.getWidget(int)

getItemPosition

public int getItemPosition(I item)

Returns the given item position.

参数:

item - the item to get the position for

返回:

the item position

getPlaceholderIndex

public int getPlaceholderIndex()

从接口复制的说明: I_CmsDropTarget

Returns the index of the placeholder or -1 if no placeholder is attached.

指定者:

getPlaceholderIndex 在接口中 I_CmsDropTarget

返回:

the index

另请参阅:

I_CmsDropTarget.getPlaceholderIndex()

insert

public void insert(com.google.gwt.user.client.ui.Widget widget,
          int position)

Inserts the given widget at the given position.

参数:

widget - the widget to insert

position - the position

insertItem

public void insertItem(I item,
              int position)

Inserts the given item at the given position.

参数:

item - the item to insert

position - the position

insertPlaceholder

public void insertPlaceholder(com.google.gwt.dom.client.Element placeholder,
                     int x,
                     int y,
                     CmsDNDHandler.Orientation orientation)

从接口复制的说明: I_CmsDropTarget

Inserts a new placeholder.

指定者:

insertPlaceholder 在接口中 I_CmsDropTarget

参数:

placeholder - the placeholder element

x - the cursor client x position

y - the cursor client y position

orientation - the drag and drop orientation

另请参阅:

org.opencms.gwt.client.dnd.I_CmsDropTarget#insertPlaceholder(com.google.gwt.dom.client.Element, int, int, Orientation)

isDNDTakeAll

public boolean isDNDTakeAll()

Returns if the list will always return true on check target requests within drag and drop.

返回:

true if take all is enabled for drag and drop

isDropEnabled

public boolean isDropEnabled()

Checks if dropping is enabled.

返回:

true if dropping is enabled

onDrop

public void onDrop(I_CmsDraggable draggable)

从接口复制的说明: I_CmsDropTarget

Executed on drop.

指定者:

onDrop 在接口中 I_CmsDropTarget

参数:

draggable - the draggable being dropped

另请参阅:

I_CmsDropTarget.onDrop(org.opencms.gwt.client.dnd.I_CmsDraggable)

remove

public boolean remove(com.google.gwt.user.client.ui.Widget w)

指定者:

remove 在接口中 com.google.gwt.user.client.ui.HasWidgets

覆盖:

remove 在类中 com.google.gwt.user.client.ui.ComplexPanel

另请参阅:

ComplexPanel.remove(com.google.gwt.user.client.ui.Widget)

removeItem

public I removeItem(I item)

Removes an item from the list.

参数:

item - the item to remove

返回:

the removed item

另请参阅:

remove(Widget)

removeItem

public I removeItem(java.lang.String itemId)

Removes an item from the list.

参数:

itemId - the id of the item to remove

返回:

the removed item

另请参阅:

remove(Widget)

removePlaceholder

public void removePlaceholder()

从接口复制的说明: I_CmsDropTarget

Removes the placeholder.

指定者:

removePlaceholder 在接口中 I_CmsDropTarget

另请参阅:

I_CmsDropTarget.removePlaceholder()

repositionPlaceholder

public void repositionPlaceholder(int x,
                         int y,
                         CmsDNDHandler.Orientation orientation)

从接口复制的说明: I_CmsDropTarget

Repositions the placeholder.

指定者:

repositionPlaceholder 在接口中 I_CmsDropTarget

参数:

x - the cursor client x position

y - the cursor client y position

orientation - the drag and drop orientation

另请参阅:

org.opencms.gwt.client.dnd.I_CmsDropTarget#repositionPlaceholder(int, int, Orientation)

setDNDHandler

public void setDNDHandler(CmsDNDHandler handler)

Sets the drag'n drop handler.

参数:

handler - the handler to set

setDNDTakeAll

public void setDNDTakeAll(boolean takeAll)

Sets if the list will always return true on check target requests within drag and drop.

参数:

takeAll - true to enable take all for drag and drop

setDropEnabled

public void setDropEnabled(boolean enabled)

Enables/disables dropping.

参数:

enabled - true to enable, or false to disable

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)

changeId

protected void changeId(I item,
            java.lang.String id)

Changes the id for the given item.

参数:

item - the item to change the id for

id - the new id

registerItem

protected void registerItem(I item)

Registers the given item on this list.

参数:

item - the item to register

setPlaceholder

protected void setPlaceholder(com.google.gwt.dom.client.Element placeholder)

Sets the current drag'n drop place holder.

参数:

placeholder - the element to set as place holder