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:

AttachNotifier, ClickNotifier<Div>, DetachNotifier, HasComponents, HasElement, HasEnabled, HasOrderedComponents, HasSize, HasStyle, HasText, Serializable

@JsModule("./code-viewer.ts") @JsModule("./source-code-viewer-buttons.ts")
public class SourceCodeViewer
extends Div
implements HasSize

See Also:

• Serialized Form

Nested Class Summary

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

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 HasElement & ClickNotifier<?>> void	highlightOnClick(T c, String filenameAndId)	Highlight block id when the component is clicked.
static void	highlightOnHover(Component c, String filenameAndId)	Highlights the block identified by filenameAndId when the component is hovered over.
void	withButtons()	Adds the overlay controls (show, hide, flip and rotate) pinned over the source code.

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

SourceCodeViewer

public SourceCodeViewer(String sourceUrl)

SourceCodeViewer

public SourceCodeViewer(String sourceUrl,
 Map<String,String> properties)

SourceCodeViewer

public SourceCodeViewer(String url,
 String language,
 Map<String,String> properties)

Method Details

withButtons

public void withButtons()

Adds the overlay controls (show, hide, flip and rotate) pinned over the source code.

The buttons do not change this viewer directly. Instead, each one dispatches a bubbling DOM event that is expected to be handled by an enclosing layout, which is what actually collapses, repositions or reorients the source panel:

• show / hide dispatch source-collapse-changed (carrying detail.collapsed);
• flip dispatches source-flip;
• rotate dispatches source-rotate.

The buttons are therefore only useful when this viewer is placed inside a layout that listens for those events and coordinates the response (see TabbedDemo); otherwise they emit events that nothing consumes.

The controls are rendered by the source-code-viewer-buttons client-side web component, which dispatches the events locally on click; the enclosing layout (see TabbedDemo) handles them through Vaadin server-side listeners. This method is idempotent: the component is added only once.

fetchContents

public void fetchContents(String url,
 String language)

highlightOnHover

public static void highlightOnHover(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 HasElement & 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 '#'.