com.flowingcode.vaadin.addons.demo

Annotation Type DemoSource

@Repeatable(value=DemoSources.class)
 @Retention(value=RUNTIME)
 @Target(value=TYPE)
public @interface DemoSource

This annotation is used for configuring the source code URL in a TabbedDemo. If no value is specified, and the demo view is annotated with GithubLink, then the source URL defaults to the location of the annotated class under src/test/java and the branch is determined from the value of GithubBranch in the demo view class (if the annotation is present) or the containing package of the demo view class. If the source URL is defaulted and no GithubBranch annotation is present either in the demo view class or its containing package, then the branch defaults to master.

Author:

Javier Godoy / Flowing Code

Field Summary

Fields

Modifier and Type	Fields and Description
static String	DEFAULT_VALUE
static String	GITHUB_SOURCE

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	caption The caption of the source tab (displayed if several sources are provided).
String	language The language used to format the sources.
SourcePosition	sourcePosition Source code position in the layout
String	value A link to the source code, if different from the annotated class.

Field Detail

GITHUB_SOURCE

public static final String GITHUB_SOURCE

DEFAULT_VALUE

public static final String DEFAULT_VALUE

Element Detail

value

public abstract String value

A link to the source code, if different from the annotated class.

Default:

"__GITHUB__"

caption

public abstract String caption

The caption of the source tab (displayed if several sources are provided). Default to the file name.

Default:

"__DEFAULT__"

language

public abstract String language

The language used to format the sources. By default the language is inferred from the file extension.

Default:

"__DEFAULT__"

sourcePosition

public abstract SourcePosition sourcePosition

Source code position in the layout

Default:

com.flowingcode.vaadin.addons.demo.SourcePosition.SECONDARY