li.cil.manual.common.api

Class ManualDefinitionImpl

java.lang.Object

li.cil.manual.common.api.ManualDefinitionImpl

All Implemented Interfaces:

ManualDefinition

public final class ManualDefinitionImpl
extends java.lang.Object
implements ManualDefinition

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ManualDefinitionImpl.History
static class	ManualDefinitionImpl.Tab

Field Summary

Fields

Modifier and Type	Field and Description
static ManualDefinitionImpl	INSTANCE

Constructor Summary

Constructors

Constructor and Description
ManualDefinitionImpl()

Method Summary

Modifier and Type	Method and Description
void	addDefaultProviders() Adds the default providers listed in the documentation.
void	addProvider(ContentProvider provider) Register a content provider.
void	addProvider(PathProvider provider) Register a path provider.
void	addProvider(java.lang.String prefix, ImageProvider provider) Register an image provider.
void	addTab(TabIconRenderer renderer, java.lang.String tooltip, java.lang.String path) Register a tab to be displayed next to the manual.
java.lang.Iterable<java.lang.String>	contentFor(java.lang.String path) Get the content of the documentation page at the specified location.
int	getHistorySize()
java.util.List<ManualDefinitionImpl.Tab>	getTabs()
ImageRenderer	imageFor(java.lang.String href) Get the image renderer for the specified image path.
static java.lang.String	makeRelative(java.lang.String path, java.lang.String base) Makes the specified path relative to the specified base path.
void	navigate(java.lang.String path) Navigate to a page in the manual.
void	openFor(net.minecraft.entity.player.EntityPlayer player) Open the manual for the specified player.
java.lang.String	pathFor(net.minecraft.item.ItemStack stack) Look up the documentation path for the specified item stack.
java.lang.String	pathFor(net.minecraft.world.World world, net.minecraft.util.math.BlockPos pos) Look up the documentation for the specified block in the world.
int	peekOffset() Looks at the history path stack and returns the scroll offset of the top entry.
java.lang.String	peekPath() Looks at the path at the top of this stack without removing it from the stack.
void	popPath() Removes the path at the top of the stack
void	pushPath(java.lang.String path) Add a path to the history stack.
void	reset() Reset the history of the manual.
void	setDefaultPage(java.lang.String defaultPage) When created, the default page is `%LANGUAGE%/index.md`, use this to change that.
void	setOffset(int offset) Sets the scroll offset of the page on top of the history stack.

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

public static final ManualDefinitionImpl INSTANCE

Constructor Detail

ManualDefinitionImpl

public ManualDefinitionImpl()

Method Detail

addTab

public void addTab(TabIconRenderer renderer,
                   @Nullable
                   java.lang.String tooltip,
                   java.lang.String path)

Description copied from interface: ManualDefinition

Register a tab to be displayed next to the manual.

These are intended to link to index pages, and for the time being there a relatively low number of tabs that can be displayed, so I'd ask you to only register as many tabs as actually, technically *needed*. Which will usually be one, for your main index page.

Specified by:

addTab in interface ManualDefinition

Parameters:

renderer - the renderer used to render the icon on your tab.

tooltip - the unlocalized tooltip of the tab, or null.

path - the path to the page to open when the tab is clicked.

addProvider

public void addProvider(PathProvider provider)

Description copied from interface: ManualDefinition

Register a path provider.

Path providers are used to find documentation entries for item stacks and blocks in the world.

Specified by:

addProvider in interface ManualDefinition

Parameters:

provider - the provider to register.

addProvider

public void addProvider(ContentProvider provider)

Description copied from interface: ManualDefinition

Register a content provider.

Content providers are used to resolve paths to page content, if the standard system (using Minecraft's resource loading facilities) fails.

This can be useful for providing dynamic content, for example.

Specified by:

addProvider in interface ManualDefinition

Parameters:

provider - the provider to register.

addProvider

public void addProvider(java.lang.String prefix,
                        ImageProvider provider)

Description copied from interface: ManualDefinition

Register an image provider.

Image providers are used to render custom content in a page. These are selected via the standard image tag of Markdown, based on the prefix of the image URL, i.e.  will select the image provider registered for the prefix prefix, and pass to it the argument data, then use the returned renderer to draw an element in the place of the tag.

Custom providers are only selected if a prefix is matched, otherwise it'll treat it as a relative path to an image to load via Minecraft's resource providing facilities, and display that.

Specified by:

addProvider in interface ManualDefinition

Parameters:

prefix - the prefix on which to use the provider.

provider - the provider to register.

addDefaultProviders

public void addDefaultProviders()

Description copied from interface: ManualDefinition

Adds the default providers listed in the documentation. They are: - TextureImageProvider - ItemImageProvider - BlockImageProvider - OreDictImageProvider

Specified by:

addDefaultProviders in interface ManualDefinition

pathFor

@Nullable
public java.lang.String pathFor(net.minecraft.item.ItemStack stack)

Description copied from interface: ManualDefinition

Look up the documentation path for the specified item stack.

Specified by:

pathFor in interface ManualDefinition

Parameters:

stack - the stack to find the documentation path for.

Returns:

the path to the page, null if none is known.

pathFor

@Nullable
public java.lang.String pathFor(net.minecraft.world.World world,
                                          net.minecraft.util.math.BlockPos pos)

Description copied from interface: ManualDefinition

Look up the documentation for the specified block in the world.

Specified by:

pathFor in interface ManualDefinition

Parameters:

world - the world containing the block.

pos - the position of the block.

Returns:

the path to the page, null if none is known.

contentFor

@Nullable
public java.lang.Iterable<java.lang.String> contentFor(java.lang.String path)

Description copied from interface: ManualDefinition

Get the content of the documentation page at the specified location.

The provided path may contain the special variable %LANGUAGE%, which will be resolved to the currently set language, falling back to en_US.

Specified by:

contentFor in interface ManualDefinition

Parameters:

path - the path of the page to get the content of.

Returns:

the content of the page, or null if none exists.

imageFor

@Nullable
public ImageRenderer imageFor(java.lang.String href)

Description copied from interface: ManualDefinition

Get the image renderer for the specified image path.

This will look for ImageProviders registered for a prefix in the specified path. If there is no match, or the matched content provider does not provide a renderer, this will return null.

Specified by:

imageFor in interface ManualDefinition

Parameters:

href - the path to the image to get the renderer for.

Returns:

the custom renderer for that path, or null if none exists.

openFor

public void openFor(net.minecraft.entity.player.EntityPlayer player)

Description copied from interface: ManualDefinition

Open the manual for the specified player.

If you wish to display a specific page, call ManualDefinition.navigate(String) after this function returns, with the path to the page to show.

Specified by:

openFor in interface ManualDefinition

Parameters:

player - the player to open the manual for.

reset

public void reset()

Description copied from interface: ManualDefinition

Reset the history of the manual.

Specified by:

reset in interface ManualDefinition

navigate

public void navigate(java.lang.String path)

Description copied from interface: ManualDefinition

Navigate to a page in the manual.

Specified by:

navigate in interface ManualDefinition

Parameters:

path - the path to navigate to.

makeRelative

public static java.lang.String makeRelative(java.lang.String path,
                                            java.lang.String base)

Makes the specified path relative to the specified base path.

Parameters:

path - the path to make relative.

base - the path to make it relative to.

Returns:

the relative path.

setDefaultPage

public void setDefaultPage(java.lang.String defaultPage)

Description copied from interface: ManualDefinition

When created, the default page is `%LANGUAGE%/index.md`, use this to change that.

Specified by:

setDefaultPage in interface ManualDefinition

Parameters:

defaultPage - the new default page location.

getHistorySize

public int getHistorySize()

Specified by:

getHistorySize in interface ManualDefinition

Returns:

the current number of pages in the history stack.

pushPath

public void pushPath(java.lang.String path)

Description copied from interface: ManualDefinition

Add a path to the history stack.

Specified by:

pushPath in interface ManualDefinition

Parameters:

path - the path to add

peekPath

public java.lang.String peekPath()

Description copied from interface: ManualDefinition

Looks at the path at the top of this stack without removing it from the stack.

Specified by:

peekPath in interface ManualDefinition

Returns:

the path at the top of the stack.

peekOffset

public int peekOffset()

Description copied from interface: ManualDefinition

Looks at the history path stack and returns the scroll offset of the top entry.

Specified by:

peekOffset in interface ManualDefinition

Returns:

the scroll offset.

setOffset

public void setOffset(int offset)

Description copied from interface: ManualDefinition

Sets the scroll offset of the page on top of the history stack.

Specified by:

setOffset in interface ManualDefinition

Parameters:

offset - the scroll offset to set.

popPath

public void popPath()

Description copied from interface: ManualDefinition

Removes the path at the top of the stack

Specified by:

popPath in interface ManualDefinition

getTabs

public java.util.List<ManualDefinitionImpl.Tab> getTabs()