Package org.opencms.ui.components.extensions

Class CmsScrollPositionCss

  • All Implemented Interfaces:
    com.vaadin.event.MethodEventSource, com.vaadin.server.ClientConnector, com.vaadin.server.Extension, com.vaadin.shared.Connector, java.io.Serializable
    public class CmsScrollPositionCss
extends com.vaadin.server.AbstractExtension
    Extension to add a CSS class to any component depending on it's scroll position.

    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

    • Constructor Summary

      Constructors 
      Constructor Description
      CmsScrollPositionCss​(com.vaadin.ui.AbstractComponent componentContainer, int scrollBarrier, int barrierMargin, java.lang.String styleName)
      Constructor.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static void addTo​(com.vaadin.ui.AbstractSingleComponentContainer componentContainer, int scrollBarrier, int barrierMargin, java.lang.String styleName)
      Adds the scroll position CSS extension to the given component
      protected CmsScrollPositionCssState getState()  

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

        extend, getParent, getSupportedParentType, remove, setParent

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

        addAttachListener, addDetachListener, addExtension, addListener, addListener, addListener, addListener, addListener, addListener, addMethodInvocationToQueue, attach, beforeClientResponse, createState, detach, encodeState, equals, fireEvent, getAllChildrenIterable, getConnectorId, getErrorHandler, getExtensions, getListeners, getResource, getRpcManager, getRpcProxy, getSession, getState, getStateType, getUI, handleConnectorRequest, hashCode, hasListeners, isAttached, isConnectorEnabled, 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, attach, beforeClientResponse, detach, encodeState, getErrorHandler, getExtensions, getRpcManager, getStateType, getUI, handleConnectorRequest, isAttached, isConnectorEnabled, markAsDirty, markAsDirtyRecursive, removeAttachListener, removeDetachListener, removeExtension, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler

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

        getConnectorId

    • Constructor Detail

      • CmsScrollPositionCss

        public CmsScrollPositionCss​(com.vaadin.ui.AbstractComponent componentContainer,
                            int scrollBarrier,
                            int barrierMargin,
                            java.lang.String styleName)
        Constructor.

        Parameters:
        componentContainer - the component to extend
        scrollBarrier - the scroll barrier
        barrierMargin - the margin
        styleName - the style name to set beyond the scroll barrier

    • Method Detail

      • addTo

        public static void addTo​(com.vaadin.ui.AbstractSingleComponentContainer componentContainer,
                         int scrollBarrier,
                         int barrierMargin,
                         java.lang.String styleName)
        Adds the scroll position CSS extension to the given component
        Parameters:
        componentContainer - the component to extend
        scrollBarrier - the scroll barrier
        barrierMargin - the margin
        styleName - the style name to set beyond the scroll barrier

      • getState

        protected CmsScrollPositionCssState getState()
        Overrides:
        getState in class com.vaadin.server.AbstractClientConnector
        See Also:
        AbstractClientConnector.getState()