Package org.opencms.gwt.client.ui

Class CmsListItem

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      class  CmsListItem.MoveHandle
      The move handle.

      • 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

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void add​(com.google.gwt.user.client.ui.Widget w)
      Adds a widget to this list item.
      protected void addCheckBox​(CmsCheckBox checkbox)
      Adds a check box to this list item.
      protected void addDecoration​(com.google.gwt.user.client.ui.Widget widget, int width, boolean first)
      Helper method for adding a decoration widget and updating the decoration width accordingly.
      void addDecorationWidget​(com.google.gwt.user.client.ui.Widget widget, int width)
      Adds a decoration widget to the list item.
      protected void addMainWidget​(com.google.gwt.user.client.ui.Widget widget)
      Adds the main widget to the list item.
      protected com.google.gwt.dom.client.Element cloneForPlaceholder​(CmsListItem listItem)
      Clones the given item to be used as a place holder.
      CmsCheckBox getCheckBox()
      Gets the checkbox of 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.
      <T> T getData()
      Gets the data belonging to the list item.
      java.util.List<com.google.gwt.user.client.ui.Widget> getDecorationWidgets()
      Returns the decoration widgets of this list item.
      java.lang.String getDndHelperClass()
      Gets the class for the DND helper.
      java.lang.String getDndParentClass()
      Gets the class for the DND parent.
      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.
      CmsListItemWidget getListItemWidget()
      Returns the list item widget of this list item, or null if this item doesn't have a list item widget.
      com.google.gwt.user.client.ui.Widget getMainWidget()
      Returns the main widget.
      I_CmsDragHandle getMoveHandle()
      Returns the move handle.
      CmsList<CmsListItem> getParentList()
      Returns the parent list.
      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.
      protected void initContent()
      This internal helper method creates the actual contents of the widget by combining the decorators and the main widget.
      protected void initContent​(com.google.gwt.user.client.ui.Widget mainWidget)
      This method is a convenience method which sets the main widget of this widget, and then calls initContent().
      protected void initContent​(CmsCheckBox checkbox, com.google.gwt.user.client.ui.Widget mainWidget)
      This method is a convenience method which sets the checkbox and main widget of this widget, and then calls initContent().
      boolean initMoveHandle​(CmsDNDHandler dndHandler)
      Initializes the move handle with the given drag and drop handler and adds it to the list item widget.
      boolean initMoveHandle​(CmsDNDHandler dndHandler, boolean addFirst)
      Initializes the move handle with the given drag and drop handler and adds it to the list item widget.
      protected int moveHandleLeft​(com.google.gwt.dom.client.Element elem)
      Gets the left edge of the move handle located in the element.
      void onDragCancel()
      Executed on drag cancel.
      void onDrop​(I_CmsDropTarget target)
      Executed on drop.
      void onStartDrag​(I_CmsDropTarget target)
      Executed on drag start.
      protected void removeDecorationWidget​(com.google.gwt.user.client.ui.Widget widget, int width)
      Removes a decoration widget.
      void setData​(java.lang.Object data)
      Sets the data for this list item.
      void setDndHelperClass​(java.lang.String dndHelperClass)
      Sets the class for the DND helper.
      void setDndParentClass​(java.lang.String dndParentClass)
      Sets the class for the DND parent.
      void setId​(java.lang.String id)
      Sets the logical id, it is not the HTML id.
      void setSmallView​(boolean smallView)
      Sets the decoration style to fit with the small view of list items.
      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

    • Method Detail

      • addDecorationWidget

        public void addDecorationWidget​(com.google.gwt.user.client.ui.Widget widget,
                                int width)
        Adds a decoration widget to the list item.

        Parameters:
        widget - the widget
        width - the widget width

      • getCheckBox

        public CmsCheckBox getCheckBox()
        Gets the checkbox of this list item.

        This method will return a checkbox if this list item has one, or null if it doesn't.

        Returns:
        a check box or null

      • getData

        public <T> T getData()
        Gets the data belonging to the list item.

        Returns:
        the data belonging to the list item

      • getDecorationWidgets

        public java.util.List<com.google.gwt.user.client.ui.Widget> getDecorationWidgets()
        Returns the decoration widgets of this list item.

        Returns:
        the decoration widgets

      • getDndHelperClass

        public java.lang.String getDndHelperClass()
        Gets the class for the DND helper.

        Returns:
        the class for the DND helper

      • getDndParentClass

        public java.lang.String getDndParentClass()
        Gets the class for the DND parent.

        Returns:
        the class for the DND parent

      • getListItemWidget

        public CmsListItemWidget getListItemWidget()
        Returns the list item widget of this list item, or null if this item doesn't have a list item widget.

        Returns:
        a list item widget or null

      • getMainWidget

        public com.google.gwt.user.client.ui.Widget getMainWidget()
        Returns the main widget.

        Returns:
        the main widget

      • initMoveHandle

        public boolean initMoveHandle​(CmsDNDHandler dndHandler)
        Initializes the move handle with the given drag and drop handler and adds it to the list item widget.

        This method will not work for list items that don't have a list-item-widget.

        Parameters:
        dndHandler - the drag and drop handler
        Returns:
        true if initialization was successful

      • initMoveHandle

        public boolean initMoveHandle​(CmsDNDHandler dndHandler,
                              boolean addFirst)
        Initializes the move handle with the given drag and drop handler and adds it to the list item widget.

        This method will not work for list items that don't have a list-item-widget.

        Parameters:
        dndHandler - the drag and drop handler
        addFirst - if true, adds the move handle as first child
        Returns:
        true if initialization was successful

      • setData

        public void setData​(java.lang.Object data)
        Sets the data for this list item.

        Parameters:
        data - the data to set

      • setDndHelperClass

        public void setDndHelperClass​(java.lang.String dndHelperClass)
        Sets the class for the DND helper.

        Parameters:
        dndHelperClass - the class for the DND helper

      • setDndParentClass

        public void setDndParentClass​(java.lang.String dndParentClass)
        Sets the class for the DND parent.

        Parameters:
        dndParentClass - the class for the DND parent

      • setSmallView

        public void setSmallView​(boolean smallView)
        Sets the decoration style to fit with the small view of list items.

        Parameters:
        smallView - true if the decoration has to fit with the small view of list items

      • addCheckBox

        protected void addCheckBox​(CmsCheckBox checkbox)
        Adds a check box to this list item.

        Parameters:
        checkbox - the check box

      • addDecoration

        protected void addDecoration​(com.google.gwt.user.client.ui.Widget widget,
                             int width,
                             boolean first)
        Helper method for adding a decoration widget and updating the decoration width accordingly.

        Parameters:
        widget - the decoration widget to add
        width - the intended width of the decoration widget
        first - if true, inserts the widget at the front of the decorations, else at the end.

      • addMainWidget

        protected void addMainWidget​(com.google.gwt.user.client.ui.Widget widget)
        Adds the main widget to the list item.

        In most cases, the widget will be a list item widget. If this is the case, then further calls to getListItemWidget() will return the widget which was passed as a parameter to this method. Otherwise, the method will return null.

        Parameters:
        widget - the main content widget

      • cloneForPlaceholder

        protected com.google.gwt.dom.client.Element cloneForPlaceholder​(CmsListItem listItem)
        Clones the given item to be used as a place holder.

        Parameters:
        listItem - the item to clone
        Returns:
        the cloned item

      • initContent

        protected void initContent()
        This internal helper method creates the actual contents of the widget by combining the decorators and the main widget.

      • initContent

        protected void initContent​(CmsCheckBox checkbox,
                           com.google.gwt.user.client.ui.Widget mainWidget)
        This method is a convenience method which sets the checkbox and main widget of this widget, and then calls initContent().

        Parameters:
        checkbox - the checkbox to add
        mainWidget - the mainWidget to add

      • initContent

        protected void initContent​(com.google.gwt.user.client.ui.Widget mainWidget)
        This method is a convenience method which sets the main widget of this widget, and then calls initContent().

        Parameters:
        mainWidget - the main widget to add

      • moveHandleLeft

        protected int moveHandleLeft​(com.google.gwt.dom.client.Element elem)
        Gets the left edge of the move handle located in the element.

        Parameters:
        elem - the element to search in
        Returns:
        the left edge of the move handle

      • removeDecorationWidget

        protected void removeDecorationWidget​(com.google.gwt.user.client.ui.Widget widget,
                                      int width)
        Removes a decoration widget.

        Parameters:
        widget - the widget to remove
        width - the widget width