Package org.opencms.ui.components

Class CmsInfoButton

java.lang.Object
com.vaadin.server.AbstractClientConnector
com.vaadin.ui.AbstractComponent
com.vaadin.ui.AbstractFocusable
com.vaadin.ui.Button
org.opencms.ui.components.CmsInfoButton
All Implemented Interfaces:
com.vaadin.event.Action.ShortcutNotifier, com.vaadin.event.ContextClickEvent.ContextClickNotifier, com.vaadin.event.FieldEvents.BlurNotifier, com.vaadin.event.FieldEvents.FocusNotifier, com.vaadin.event.MethodEventSource, com.vaadin.server.ClientConnector, com.vaadin.server.Sizeable, com.vaadin.shared.Connector, com.vaadin.ui.Component, com.vaadin.ui.Component.Focusable, Serializable
public class CmsInfoButton extends com.vaadin.ui.Button
Class for the info button used in toolbar.

See Also:

  • Nested Class Summary

    Nested classes/interfaces inherited from class com.vaadin.ui.Button

    com.vaadin.ui.Button.ClickEvent, com.vaadin.ui.Button.ClickListener, com.vaadin.ui.Button.ClickShortcut

    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.server.Sizeable

    com.vaadin.server.Sizeable.Unit

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected String
    m_windowCaption
    Caption for information window.

    Fields inherited from class com.vaadin.ui.Button

    clickShortcut

    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

  • Constructor Summary

    Constructors
    Constructor
    Description
    CmsInfoButton()
    public constructor.
    CmsInfoButton(List<String> htmlLines)
    public constructor.
    CmsInfoButton(Map<String,String> infos)
    public constructor.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addAdditionalElement(com.vaadin.ui.Component component)
    Adds a vaadin element to window at last position.
    void
    addAdditionalElement(com.vaadin.ui.Component component, int pos)
    Adds a vaadin element to window.
    com.vaadin.v7.ui.VerticalLayout
    getInfoLayout()
    Get the info layout.
    protected com.vaadin.v7.ui.VerticalLayout
    getLayout(List<String> htmlLines, List<org.opencms.ui.components.CmsInfoButton.InfoElementBean> additionalElements)
    The layout which is shown in window by triggering onclick event of button.
    void
    replaceData(Map<String,String> data)
    Replaces current Map with new map.
    void
    setAdditionalButton(com.vaadin.ui.Button button)
     
    void
    setWindowCaption(String caption)
    Sets the caption of the information window.

    Methods inherited from class com.vaadin.ui.Button

    addClickListener, click, fireClick, fireClick, getCustomAttributes, getIconAlternateText, getState, getState, isDisableOnClick, isHtmlContentAllowed, readDesign, removeClickListener, removeClickShortcut, setClickShortcut, setDisableOnClick, setHtmlContentAllowed, setIcon, setIconAlternateText, writeDesign

    Methods inherited from class com.vaadin.ui.AbstractFocusable

    addBlurListener, addFocusListener, focus, getTabIndex, setTabIndex

    Methods inherited from class com.vaadin.ui.AbstractComponent

    addContextClickListener, addListener, addShortcutListener, addStyleName, attach, beforeClientResponse, detach, findAncestor, fireComponentErrorEvent, fireComponentEvent, getActionManager, getCaption, getComponentError, 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, setHeight, setHeightFull, setHeightUndefined, setIcon, setId, setLocale, setParent, setPrimaryStyleName, setReadOnly, setRequiredIndicatorVisible, setResponsive, setSizeFull, setSizeUndefined, setStyleName, setVisible, setWidth, 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.event.Action.ShortcutNotifier

    addShortcutListener, removeShortcutListener

    Methods inherited from interface com.vaadin.server.ClientConnector

    addAttachListener, addDetachListener, beforeClientResponse, detach, encodeState, getErrorHandler, getExtensions, getRpcManager, getStateType, handleConnectorRequest, isAttached, isConnectorEnabled, markAsDirty, 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.shared.Connector

    getConnectorId

    Methods inherited from interface com.vaadin.server.Sizeable

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

  • Field Details

  • Constructor Details

  • Method Details

    • addAdditionalElement

      public void addAdditionalElement(com.vaadin.ui.Component component)
      Adds a vaadin element to window at last position.

      Parameters:
      component - to be added

    • addAdditionalElement

      public void addAdditionalElement(com.vaadin.ui.Component component, int pos)
      Adds a vaadin element to window.

      Parameters:
      component - to be added
      pos - position in vertical layout

    • getInfoLayout

      public com.vaadin.v7.ui.VerticalLayout getInfoLayout()
      Get the info layout.

      Returns:
      VerticalLayout

    • replaceData

      public void replaceData(Map<String,String> data)
      Replaces current Map with new map.

      Parameters:
      data - to replace the old map

    • setAdditionalButton

      public void setAdditionalButton(com.vaadin.ui.Button button)

    • setWindowCaption

      public void setWindowCaption(String caption)
      Sets the caption of the information window.

      Parameters:
      caption - to be set

    • getLayout

      protected com.vaadin.v7.ui.VerticalLayout getLayout(List<String> htmlLines, List<org.opencms.ui.components.CmsInfoButton.InfoElementBean> additionalElements)
      The layout which is shown in window by triggering onclick event of button.

      Parameters:
      htmlLines - to be shown
      additionalElements - further vaadin elements
      Returns:
      vertical layout