Package org.opencms.ui.components

Class CmsResourceInfo

  • All Implemented Interfaces:
    com.vaadin.event.ConnectorEventListener, com.vaadin.event.ContextClickEvent.ContextClickNotifier, com.vaadin.event.MethodEventSource, com.vaadin.event.SerializableEventListener, com.vaadin.server.ClientConnector, com.vaadin.server.Sizeable, com.vaadin.server.VariableOwner, com.vaadin.shared.Connector, com.vaadin.ui.Component, com.vaadin.ui.ComponentContainer, com.vaadin.ui.HasComponents, com.vaadin.ui.HasComponents.ComponentAttachDetachNotifier, com.vaadin.ui.Layout, com.vaadin.ui.LegacyComponent, java.io.Serializable, java.lang.Iterable<com.vaadin.ui.Component>, java.util.EventListener
    public class CmsResourceInfo
extends com.vaadin.ui.CustomLayout
    Class representing a resource info box.

    See Also:
    Serialized Form

    • Nested Class Summary

      • Nested classes/interfaces inherited from interface com.vaadin.server.ClientConnector

        com.vaadin.server.ClientConnector.AttachEvent, com.vaadin.server.ClientConnector.AttachListener, com.vaadin.server.ClientConnector.ConnectorErrorEvent, com.vaadin.server.ClientConnector.DetachEvent, com.vaadin.server.ClientConnector.DetachListener

      • Nested classes/interfaces inherited from interface com.vaadin.ui.Component

        com.vaadin.ui.Component.ErrorEvent, com.vaadin.ui.Component.Event, com.vaadin.ui.Component.Focusable, com.vaadin.ui.Component.Listener

      • Nested classes/interfaces inherited from interface com.vaadin.ui.HasComponents

        com.vaadin.ui.HasComponents.ComponentAttachDetachNotifier, com.vaadin.ui.HasComponents.ComponentAttachEvent, com.vaadin.ui.HasComponents.ComponentAttachListener, com.vaadin.ui.HasComponents.ComponentDetachEvent, com.vaadin.ui.HasComponents.ComponentDetachListener

      • Nested classes/interfaces inherited from interface com.vaadin.ui.Layout

        com.vaadin.ui.Layout.AlignmentHandler, com.vaadin.ui.Layout.MarginHandler, com.vaadin.ui.Layout.SpacingHandler

      • Nested classes/interfaces inherited from interface com.vaadin.server.Sizeable

        com.vaadin.server.Sizeable.Unit

    • Field Summary

      • Fields inherited from class com.vaadin.ui.AbstractComponent

        DESIGN_ATTR_PLAIN_TEXT

      • Fields inherited from interface com.vaadin.server.Sizeable

        SIZE_UNDEFINED, UNITS_CM, UNITS_EM, UNITS_EX, UNITS_INCH, UNITS_MM, UNITS_PERCENTAGE, UNITS_PICAS, UNITS_PIXELS, UNITS_POINTS

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static CmsResourceInfo createSitemapResourceInfo​(CmsResource resource, CmsSite baseSite)
      Creates a resource info widget for a resource that looks like the sitemap entry for that resource.
      void decorateTopInput()  
      void decorateTopLabel()  
      com.vaadin.v7.ui.Label getBottomLine()
      Gets the bottom label.
      com.vaadin.ui.Component getButtonWidget()
      Gets the button label.
      CmsResourceIcon getResourceIcon()
      Gets the resource icon.
      com.vaadin.ui.TextField getTopInput()
      Returns the editable text on top.
      com.vaadin.v7.ui.Label getTopLine()
      Gets the top label.
      void setButtonWidget​(com.vaadin.ui.Component button)
      Replaces the button component.
      void setTopLineText​(java.lang.String text)
      Replaces the text of the top label and top input.

      • Methods inherited from class com.vaadin.ui.CustomLayout

        addComponent, addComponent, changeVariables, getComponent, getComponentCount, getState, getState, getTemplateContents, getTemplateName, initTemplateContentsFromInputStream, iterator, paintContent, readDesign, removeComponent, removeComponent, replaceComponent, setTemplateContents, setTemplateName, writeDesign

      • Methods inherited from class com.vaadin.ui.AbstractLayout

        readMargin, writeMargin

      • Methods inherited from class com.vaadin.ui.AbstractComponentContainer

        addComponentAttachListener, addComponentDetachListener, addComponents, fireComponentAttachEvent, fireComponentDetachEvent, getComponentIterator, moveComponentsFrom, removeAllComponents, removeComponentAttachListener, removeComponentDetachListener, setHeight, setWidth

      • Methods inherited from class com.vaadin.ui.AbstractComponent

        addContextClickListener, addListener, addShortcutListener, addStyleName, attach, beforeClientResponse, detach, findAncestor, fireComponentErrorEvent, fireComponentEvent, focus, getActionManager, getCaption, getComponentError, getCustomAttributes, getData, getDebugId, getDescription, getErrorMessage, getHeight, getHeightUnits, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getWidth, getWidthUnits, isCaptionAsHtml, isConnectorEnabled, isEnabled, isOrHasAncestor, isReadOnly, isRequiredIndicatorVisible, isResponsive, isVisible, removeContextClickListener, removeListener, removeShortcutListener, removeStyleName, setCaption, setCaptionAsHtml, setComponentError, setData, setDebugId, setDescription, setDescription, setEnabled, setHeight, setHeightFull, setHeightUndefined, setIcon, setId, setLocale, setParent, setPrimaryStyleName, setReadOnly, setRequiredIndicatorVisible, setResponsive, setSizeFull, setSizeUndefined, setStyleName, setVisible, setWidth, setWidthFull, setWidthUndefined

      • Methods inherited from class com.vaadin.server.AbstractClientConnector

        addAttachListener, addDetachListener, addExtension, addListener, addListener, addListener, addListener, addListener, addListener, addMethodInvocationToQueue, createState, encodeState, equals, fireEvent, getAllChildrenIterable, getConnectorId, getErrorHandler, getExtensions, getListeners, getResource, getRpcManager, getRpcProxy, getSession, getStateType, getUI, handleConnectorRequest, hashCode, hasListeners, isAttached, isThis, markAsDirty, markAsDirtyRecursive, registerRpc, registerRpc, removeAttachListener, removeDetachListener, removeExtension, removeListener, removeListener, removeListener, removeListener, removeListener, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler, setResource, updateDiffstate

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

      • Methods inherited from interface com.vaadin.server.ClientConnector

        addAttachListener, addDetachListener, beforeClientResponse, detach, encodeState, getErrorHandler, getExtensions, getRpcManager, getStateType, handleConnectorRequest, isAttached, isConnectorEnabled, markAsDirtyRecursive, removeAttachListener, removeDetachListener, removeExtension, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler

      • Methods inherited from interface com.vaadin.ui.Component

        addListener, addStyleName, addStyleNames, attach, getCaption, getDescription, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getUI, isEnabled, isVisible, removeListener, removeStyleName, removeStyleNames, setCaption, setEnabled, setIcon, setId, setParent, setPrimaryStyleName, setStyleName, setStyleName, setVisible

      • Methods inherited from interface com.vaadin.ui.ComponentContainer

        addComponents, getComponentIterator, moveComponentsFrom, removeAllComponents

      • Methods inherited from interface com.vaadin.shared.Connector

        getConnectorId

      • Methods inherited from interface com.vaadin.ui.HasComponents.ComponentAttachDetachNotifier

        addComponentAttachListener, addComponentDetachListener, removeComponentAttachListener, removeComponentDetachListener

      • Methods inherited from interface java.lang.Iterable

        forEach, spliterator

      • Methods inherited from interface com.vaadin.ui.LegacyComponent

        markAsDirty

      • Methods inherited from interface com.vaadin.server.Sizeable

        getHeight, getHeightUnits, getWidth, getWidthUnits, setHeight, setHeight, setHeightFull, setHeightUndefined, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthFull, setWidthUndefined

      • Methods inherited from interface com.vaadin.server.VariableOwner

        isEnabled

    • Constructor Detail

      • CmsResourceInfo

        public CmsResourceInfo​(CmsResource resource,
                       boolean useState)
        Constructor.

        Parameters:
        resource - the resource
        useState - true if the resource state should be displayed

      • CmsResourceInfo

        public CmsResourceInfo​(java.lang.String top,
                       java.lang.String bottom,
                       com.vaadin.server.Resource iconResource)
        Constructor.

        Parameters:
        top - the title
        bottom - the sub title
        iconResource - the icon resource path

      • CmsResourceInfo

        public CmsResourceInfo​(java.lang.String top,
                       java.lang.String bottom,
                       java.lang.String iconPath)
        Constructor.

        Parameters:
        top - the title
        bottom - the sub title
        iconPath - the icon resource path

    • Method Detail

      • createSitemapResourceInfo

        public static CmsResourceInfo createSitemapResourceInfo​(CmsResource resource,
                                                        CmsSite baseSite)
        Creates a resource info widget for a resource that looks like the sitemap entry for that resource.

        Parameters:
        resource - the resource
        baseSite - the base site
        Returns:
        the resource info widget

      • getBottomLine

        public com.vaadin.v7.ui.Label getBottomLine()
        Gets the bottom label.

        Returns:
        the bottom label

      • getButtonWidget

        public com.vaadin.ui.Component getButtonWidget()
        Gets the button label.

        Returns:
        the button label

      • getTopInput

        public com.vaadin.ui.TextField getTopInput()
        Returns the editable text on top.

        Returns:
        the editable text on top

      • getTopLine

        public com.vaadin.v7.ui.Label getTopLine()
        Gets the top label.

        Returns:
        the top label

      • setButtonWidget

        public void setButtonWidget​(com.vaadin.ui.Component button)
        Replaces the button component.

        Parameters:
        button - the new button component

      • setTopLineText

        public void setTopLineText​(java.lang.String text)
        Replaces the text of the top label and top input.
        Parameters:
        text - the text