org.opencms.gwt.client.ui

Class CmsSimpleListItem

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

All Implemented Interfaces:

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.IsRenderable, com.google.gwt.user.client.ui.IsWidget, I_CmsDraggable, I_CmsListItem, I_CmsTruncable

public class CmsSimpleListItem
extends com.google.gwt.user.client.ui.Composite
implements I_CmsListItem

Provides a UI list item.

Since:

8.0.0

Nested Class Summary

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

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

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	m_id The logical id, it is not the HTML id.
protected CmsFlowPanel	m_panel The underlying panel.

Fields inherited from class com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor and Description
CmsSimpleListItem() Constructor.
CmsSimpleListItem(CmsListItemWidget widget) Constructor.

Method Summary

Modifier and Type	Method and Description
void	add(com.google.gwt.user.client.ui.Widget w) Adds a widget to this list item.
com.google.common.base.Optional<int[]>	getCursorOffsetDelta() Gets an optional pair of integers which are to be used as an "offset delta" for the drag and drop process.
com.google.gwt.dom.client.Element	getDragHelper(I_CmsDropTarget target) Creates the drag helper element and attaches it into the DOM.
java.lang.String	getId() Returns the logical id, it is not the HTML id.
I_CmsDropTarget	getParentTarget() Returns the parent drop target or null if there is none.
com.google.gwt.dom.client.Element	getPlaceholder(I_CmsDropTarget target) Creates the drag placeholder element.
com.google.gwt.user.client.ui.Widget	getWidget(int index) Returns the child widget with the given index.
void	onDragCancel() Executed on drag cancel.
void	onDrop(I_CmsDropTarget target) Executed on drop.
void	onStartDrag(I_CmsDropTarget target) Executed on drag start.
void	setId(java.lang.String id) Sets the logical id, it is not the HTML id.
void	truncate(java.lang.String textMetricsPrefix, int widgetWidth) Truncates long text and sets the original text to the title attribute.

Methods inherited from class com.google.gwt.user.client.ui.Composite

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

Methods inherited from class 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, unsinkEvents

Methods inherited from class 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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opencms.gwt.client.dnd.I_CmsDraggable

getElement

Field Detail

m_id

protected java.lang.String m_id

The logical id, it is not the HTML id.

m_panel

protected CmsFlowPanel m_panel

The underlying panel.

Constructor Detail

CmsSimpleListItem

public CmsSimpleListItem()

Constructor.

CmsSimpleListItem

public CmsSimpleListItem(CmsListItemWidget widget)

Constructor.

Parameters:

widget - the widget to use

Method Detail

add

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

Description copied from interface: I_CmsListItem

Adds a widget to this list item.

Specified by:

add in interface I_CmsListItem

Parameters:

w - the widget to add

See Also:

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

getCursorOffsetDelta

public com.google.common.base.Optional<int[]> getCursorOffsetDelta()

Description copied from interface: I_CmsDraggable

Gets an optional pair of integers which are to be used as an "offset delta" for the drag and drop process.

Specified by:

getCursorOffsetDelta in interface I_CmsDraggable

Returns:

an optional array containing exactly 2 entries [x,y]

See Also:

I_CmsDraggable.getCursorOffsetDelta()

getDragHelper

public com.google.gwt.dom.client.Element getDragHelper(I_CmsDropTarget target)

Description copied from interface: I_CmsDraggable

Creates the drag helper element and attaches it into the DOM.

Specified by:

getDragHelper in interface I_CmsDraggable

Parameters:

target - the drop target

Returns:

the drag helper element

See Also:

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

getId

public java.lang.String getId()

Description copied from interface: I_CmsListItem

Returns the logical id, it is not the HTML id.

Specified by:

getId in interface I_CmsDraggable

Specified by:

getId in interface I_CmsListItem

Returns:

the id

See Also:

I_CmsListItem.getId()

getParentTarget

public I_CmsDropTarget getParentTarget()

Description copied from interface: I_CmsDraggable

Returns the parent drop target or null if there is none.

Specified by:

getParentTarget in interface I_CmsDraggable

Returns:

the parent drop target

See Also:

I_CmsDraggable.getParentTarget()

getPlaceholder

public com.google.gwt.dom.client.Element getPlaceholder(I_CmsDropTarget target)

Description copied from interface: I_CmsDraggable

Creates the drag placeholder element.

Specified by:

getPlaceholder in interface I_CmsDraggable

Parameters:

target - the drop target

Returns:

the drag placeholder element

See Also:

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

getWidget

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

Returns the child widget with the given index.

Parameters:

index - the index

Returns:

the child widget

onDragCancel

public void onDragCancel()

Description copied from interface: I_CmsDraggable

Executed on drag cancel.

Specified by:

onDragCancel in interface I_CmsDraggable

See Also:

I_CmsDraggable.onDragCancel()

onDrop

public void onDrop(I_CmsDropTarget target)

Description copied from interface: I_CmsDraggable

Executed on drop.

Specified by:

onDrop in interface I_CmsDraggable

Parameters:

target - the drop target

See Also:

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

onStartDrag

public void onStartDrag(I_CmsDropTarget target)

Description copied from interface: I_CmsDraggable

Executed on drag start.

Specified by:

onStartDrag in interface I_CmsDraggable

Parameters:

target - the current drop target

See Also:

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

setId

public void setId(java.lang.String id)

Description copied from interface: I_CmsListItem

Sets the logical id, it is not the HTML id.

Specified by:

setId in interface I_CmsListItem

Parameters:

id - the id to set

See Also:

I_CmsListItem.setId(java.lang.String)

truncate

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

Description copied from interface: I_CmsTruncable

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

Specified by:

truncate in interface I_CmsTruncable

Parameters:

textMetricsPrefix - the key identifying the text metrics to use

widgetWidth - the width to use in pixels

See Also:

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