org.shredzone.flattr4j.web.builder

Class LoaderBuilder

java.lang.Object

org.shredzone.flattr4j.web.builder.LoaderBuilder

All Implemented Interfaces:

Serializable

public class LoaderBuilder
extends Object
implements Serializable

Builds the JavaScript loader for the Flattr API.

The builder uses sensible default settings that can be changed by using its methods. All methods return a reference to the builder itself, so method calls can be daisy-chained.

Example: String loader = new LoaderBuilder().uid("123456").toString();

Author:

Richard "Shred" Körber

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
LoaderBuilder()

Method Summary

Modifier and Type	Method and Description
LoaderBuilder	bare() The builder will return a bare javascript, without an enclosing <script> tag.
LoaderBuilder	baseUrl(String baseUrl) Sets the base URL of the Flattr API.
LoaderBuilder	button(ButtonType type) Sets the default button type to be used.
LoaderBuilder	category(CategoryId category) Sets the default Category.
LoaderBuilder	https() Use https for loading Flattr resources (javascripts, images etc).
LoaderBuilder	language(LanguageId language) Sets the default Language.
LoaderBuilder	manual() The Flattr API will not be initialized automatically, but requires a manual invocation of FlattrLoader.setup().
LoaderBuilder	popout(boolean popout) Sets whether to override the popout default and show a popout when hovering with the mouse over the button.
LoaderBuilder	prefix(String prefix) Sets a HTML5 key prefix.
String	toString() Builds a loader script of the current setup.
LoaderBuilder	user(UserId user) Sets the default User.
LoaderBuilder	version(String version) Sets the API version to be used.

Methods inherited from class java.lang.Object

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

Constructor Detail

LoaderBuilder

public LoaderBuilder()

Method Detail

baseUrl

public LoaderBuilder baseUrl(String baseUrl)

Sets the base URL of the Flattr API. Defaults to "http://api.flattr.com". Do not change unless you know what you are doing.

Parameters:

baseUrl - New Flattr API url to be used

version

public LoaderBuilder version(String version)

Sets the API version to be used. Usually there is no need to change the default value, so do not change unless you know what you are doing.

Parameters:

version - API version to be used (e.g. "0.6")

bare

public LoaderBuilder bare()

The builder will return a bare javascript, without an enclosing <script> tag.

manual

public LoaderBuilder manual()

The Flattr API will not be initialized automatically, but requires a manual invocation of FlattrLoader.setup(). By default, the API is initialized automatically on onload.

popout

public LoaderBuilder popout(boolean popout)

Sets whether to override the popout default and show a popout when hovering with the mouse over the button.

Parameters:

popout - true: always show a popout, false: never show a popout

Since:

2.2

https

public LoaderBuilder https()

Use https for loading Flattr resources (javascripts, images etc). By default http is used.

user

public LoaderBuilder user(UserId user)

Sets the default User.

Parameters:

user - UserId

button

public LoaderBuilder button(ButtonType type)

Sets the default button type to be used.

Parameters:

type - ButtonType to be used

language

public LoaderBuilder language(LanguageId language)

Sets the default Language.

Parameters:

language - Default LanguageId

category

public LoaderBuilder category(CategoryId category)

Sets the default Category.

Parameters:

category - Default CategoryId

prefix

public LoaderBuilder prefix(String prefix)

Sets a HTML5 key prefix. By default "data-flattr" is used.

Parameters:

prefix - HTML5 key prefix. The string must start with "data-"

toString

public String toString()

Builds a loader script of the current setup.

Overrides:

toString in class Object