Package com.flowingcode.vaadin.addons.demo

Class SourceCodeViewer

java.lang.Object
com.vaadin.flow.component.Component
com.vaadin.flow.component.HtmlComponent
com.vaadin.flow.component.HtmlContainer
com.vaadin.flow.component.html.Div
com.flowingcode.vaadin.addons.demo.SourceCodeViewer
All Implemented Interfaces:
com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.ClickNotifier<com.vaadin.flow.component.html.Div>, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.HasComponents, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasEnabled, com.vaadin.flow.component.HasOrderedComponents, com.vaadin.flow.component.HasSize, com.vaadin.flow.component.HasStyle, com.vaadin.flow.component.HasText, Serializable
@JsModule("./code-viewer.ts") public class SourceCodeViewer extends com.vaadin.flow.component.html.Div implements com.vaadin.flow.component.HasSize
See Also:

  • Nested Class Summary

    Nested classes/interfaces inherited from interface com.vaadin.flow.component.HasText

    com.vaadin.flow.component.HasText.WhiteSpace

  • Constructor Summary

    Constructors
    Constructor
    Description
    SourceCodeViewer(String sourceUrl)
     
    SourceCodeViewer(String url, String language, Map<String,String> properties)
     
    SourceCodeViewer(String sourceUrl, Map<String,String> properties)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    fetchContents(String url, String language)
     
    static void
    highlight(String filenameAndId)
    Highlights the block identified by filenameAndId.
    static <T extends com.vaadin.flow.component.HasElement & com.vaadin.flow.component.ClickNotifier<?>>
    void
    highlightOnClick(T c, String filenameAndId)
    Highlight block id when the component is clicked.
    static void
    highlightOnHover(com.vaadin.flow.component.Component c, String filenameAndId)
    Highlights the block identified by filenameAndId when the component is hovered over.

    Methods inherited from class com.vaadin.flow.component.HtmlComponent

    getTitle, setTitle

    Methods inherited from class com.vaadin.flow.component.Component

    addListener, findAncestor, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getListeners, getLocale, getParent, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onAttach, onDetach, onEnabledStateChanged, removeFromParent, scrollIntoView, scrollIntoView, set, setElement, setId, setVisible

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface com.vaadin.flow.component.AttachNotifier

    addAttachListener

    Methods inherited from interface com.vaadin.flow.component.ClickNotifier

    addClickListener, addClickShortcut, addDoubleClickListener, addSingleClickListener

    Methods inherited from interface com.vaadin.flow.component.DetachNotifier

    addDetachListener

    Methods inherited from interface com.vaadin.flow.component.HasComponents

    add, add, add, addComponentAsFirst, addComponentAtIndex, remove, remove, removeAll

    Methods inherited from interface com.vaadin.flow.component.HasElement

    getElement

    Methods inherited from interface com.vaadin.flow.component.HasEnabled

    isEnabled, setEnabled

    Methods inherited from interface com.vaadin.flow.component.HasOrderedComponents

    getChildren, getComponentAt, getComponentCount, indexOf, replace

    Methods inherited from interface com.vaadin.flow.component.HasSize

    getHeight, getHeightUnit, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getWidth, getWidthUnit, setHeight, setHeight, setHeightFull, setMaxHeight, setMaxHeight, setMaxWidth, setMaxWidth, setMinHeight, setMinHeight, setMinWidth, setMinWidth, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthFull

    Methods inherited from interface com.vaadin.flow.component.HasStyle

    addClassName, addClassNames, getClassName, getClassNames, getStyle, hasClassName, removeClassName, removeClassNames, setClassName, setClassName

    Methods inherited from interface com.vaadin.flow.component.HasText

    getText, getWhiteSpace, setText, setWhiteSpace

  • Constructor Details

  • Method Details

    • fetchContents

      public void fetchContents(String url, String language)

    • highlightOnHover

      public static void highlightOnHover(com.vaadin.flow.component.Component c, String filenameAndId)
      Highlights the block identified by filenameAndId when the component is hovered over.

      If the component is in an additional source, filenameAndId can be given as a string in the format filename#id. If no '#' is present, it is assumed that the identifier corresponds to a block in the first source panel.

      Parameters:
      c - The component that triggers the highlight action when hovered over.
      filenameAndId - The identifier string that combines filename and id separated by '#'.

    • highlightOnClick

      public static <T extends com.vaadin.flow.component.HasElement & com.vaadin.flow.component.ClickNotifier<?>> void highlightOnClick(T c, String filenameAndId)
      Highlight block id when the component is clicked.

      If the component is in an additional source, filenameAndId can be given as a string in the format filename#id. If no '#' is present, it is assumed that the identifier corresponds to a block in the first source panel.

      Parameters:
      c - The component that triggers the highlight action when clicked.
      filenameAndId - The identifier string that combines filename and id separated by '#'.

    • highlight

      public static void highlight(String filenameAndId)
      Highlights the block identified by filenameAndId.

      If the component is in an additional source, filenameAndId can be given as a string in the format filename#id. If no '#' is present, it is assumed that the identifier corresponds to a block in the first source panel.

      Parameters:
      filenameAndId - The identifier string that combines filename and id separated by '#'.