net.risingworld.api.gui

Class GuiFileBrowser

java.lang.Object

net.risingworld.api.gui.GuiElement

net.risingworld.api.gui.GuiFileBrowser

public class GuiFileBrowser
extends GuiElement

A file browser gui element which enables the player to browse his files. Once a file is selected, the onFileSelect() method will be called and a PlayerSelectFileEvent event will be triggered.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	USER_DIR Represents the users working directory (usually this is the game directory)
static java.lang.String	USER_HOME Represents the user home directory (on Windows, this would be usually C:\Users\Username\)

Constructor Summary

Constructors

Constructor and Description
GuiFileBrowser(float x, float y, boolean relativeposition, float width, float height, boolean relativesize) Creates a new file browser element with the given size at the given screen position.
GuiFileBrowser(int entryCount, float x, float y, boolean relativeposition, float width, float height, boolean relativesize) Creates a new file browser element with the given size at the given screen position.

Method Summary

Modifier and Type	Method and Description
void	getCurrentDirectory(Player player, Callback<java.lang.String> callback) Gets the current directory.
java.lang.String	getDefaultDirectory() Gets the default directory.
int	getEntryCount() Gets the amount of entries that will be shown by the file browser (without having to scroll).
java.lang.String[]	getFileExtensionFilter() Gets the file extension filter (if set), i.e. an array of allowed file extension types.
int	getPreviewImageDimension()
float	getPreviewImagePositionX()
float	getPreviewImagePositionY()
boolean	isClickable()
boolean	isPreviewImageEnabled() Gets whether or not a file preview is enabled for this file browser.
boolean	isRelativePreviewImagePosition()
void	onFileSelect(PlayerSelectFileEvent event)
void	refresh() Refreshes this element, i.e. synchronizes it between the client and the server.
void	setClickable(boolean set)
void	setColor(float r, float g, float b, float a) Sets the background color for the file browser element.
void	setColor(int color) Sets the background color for the file browser element.
void	setDirectory(java.lang.String path) Switches the view of the file browser to the specified directory (client side).
void	setEntryCount(int count) Sets the amount of entries that will be shown by the file browser (without having to scroll).
void	setFileExtensionFilter(java.lang.String... extension) Sets a filter to show only files with the provided extension.
void	setPreviewImageDimension(int dimension)
void	setPreviewImageEnabled(boolean set) Enables a file preview, e.g. a small preview will be shown when selecting a file.
void	setPreviewImagePosition(float x, float y, boolean relative) Sets the position of the preview image (if enabled).

Methods inherited from class net.risingworld.api.gui.GuiElement

addChild, destroy, equals, getAlpha, getBorderColor, getBorderThickness, getChildren, getColor, getHeight, getHoverColor, getID, getParent, getParentID, getPivot, getPositionX, getPositionY, getWidth, hashCode, isAlwaysInBackground, isAlwaysOnTop, isRelativeBorderThickness, isRelativePosition, isRelativeSize, isVisible, onClick, removeAllChildren, removeChild, removeFromParent, setAlpha, setAlwaysInBackground, setAlwaysOnTop, setBorderColor, setBorderColor, setBorderThickness, setPivot, setPosition, setSize, setVisible

Methods inherited from class java.lang.Object

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

Field Detail

USER_DIR

public static final java.lang.String USER_DIR

Represents the users working directory (usually this is the game directory)

See Also:

Constant Field Values

USER_HOME

public static final java.lang.String USER_HOME

Represents the user home directory (on Windows, this would be usually C:\Users\Username\)

See Also:

Constant Field Values

Constructor Detail

GuiFileBrowser

public GuiFileBrowser(float x,
                      float y,
                      boolean relativeposition,
                      float width,
                      float height,
                      boolean relativesize)

Creates a new file browser element with the given size at the given screen position.

Parameters:

x - the x screen position (horizontally).

y - the y screen position (vertically).

relativeposition - false to use absolute coordinates (i.e. pixel coordinates), or true to use relative coordinates (range between 0.0 and 1.0)

height - the height of this file browser element.

width - the width of this file browser element.

relativesize - false to use an absolute width (width in pixels), or true to use a relative width/height (range between 0.0 and 1.0)

GuiFileBrowser

public GuiFileBrowser(int entryCount,
                      float x,
                      float y,
                      boolean relativeposition,
                      float width,
                      float height,
                      boolean relativesize)

Creates a new file browser element with the given size at the given screen position.

Parameters:

entryCount - the amount of visible entries, i.e. the amount of entries that will be shown without having to scroll. Default value is 10. This has a direct impact on the entry size (entry size = height / entryCount). Note that the total size also contains a small gap between every entry (1 px) as well as some extra space for the head bar (around 80 px).

x - the x screen position (horizontally).

y - the y screen position (vertically).

relativeposition - false to use absolute coordinates (i.e. pixel coordinates), or true to use relative coordinates (range between 0.0 and 1.0)

height - the height of this file browser element.

width - the width of this file browser element.

relativesize - false to use an absolute width (width in pixels), or true to use a relative width/height (range between 0.0 and 1.0)

Method Detail

setEntryCount

public void setEntryCount(int count)

Sets the amount of entries that will be shown by the file browser (without having to scroll). Default value is 10. This value has a direct impact on the entry size (entry size = height / entryCount). Note that the total size also contains a small gap between every entry as well as some extra space for the head bar.

Parameters:

count - the amount of visible entries (default: 10)

getEntryCount

public int getEntryCount()

Gets the amount of entries that will be shown by the file browser (without having to scroll).

Returns:

the amount of visible entries (default: 10)

setPreviewImageEnabled

public void setPreviewImageEnabled(boolean set)

Enables a file preview, e.g. a small preview will be shown when selecting a file. Only makes sense for images (e.g. jpg, png, gif files etc). Disabled by default.

Parameters:

set - true to enable the file preview, false to disable it (default).

See Also:

setPreviewImagePosition(float, float, boolean)

isPreviewImageEnabled

public boolean isPreviewImageEnabled()

Gets whether or not a file preview is enabled for this file browser.

Returns:

true if a preview image will be shown, false if not.

setPreviewImagePosition

public void setPreviewImagePosition(float x,
                                    float y,
                                    boolean relative)

Sets the position of the preview image (if enabled). Note that the preview image is a child element of the file browser, so the coordinates are always relative to the file browser coordinates.

Parameters:

x - the x (horizontal) position.

y - the y (vertical) position.

relative - set to false to use absolute coordinates (i.e. pixel coordinates), or true to use relative coordinates (range between 0 and 1).

getPreviewImagePositionX

public float getPreviewImagePositionX()

getPreviewImagePositionY

public float getPreviewImagePositionY()

isRelativePreviewImagePosition

public boolean isRelativePreviewImagePosition()

setPreviewImageDimension

public void setPreviewImageDimension(int dimension)

getPreviewImageDimension

public int getPreviewImageDimension()

setDirectory

public void setDirectory(java.lang.String path)

Switches the view of the file browser to the specified directory (client side). If the directory does not exist, the game directory will be used instead.
There are two special, platform-independent directories available:
- Use "*" (or the static variable USER_DIR) to get the working directory. Usually this is the game directory - Use "**" (or the static variable USER_HOME) to get the user home directory (on Windows, this would be usually C:\Users\Username\)
Use these placeholders instead of something like System.getProperty(""), since that function would not work to get the client side directories (unless this plugin is solely intended for singleplayer).

Parameters:

path - the directory (client side).

Example #1: Show "Blueprint" folder in game directory

1	//Create a new file browser object
2	GuiFileBrowser fileBrowser = new GuiFileBrowser(0.5f, 0.5f, true, 0.6f, 0.4f, true);
3
4	//Change the directory to the "Blueprints" directory
5	fileBrowser.setDirectory(GuiFileBrowser.USER_DIR + "/Blueprints/");
6
7	//Now find a player (so you can attach the file browser to his screen)
8	Player player = getServer().getPlayer("MrPlow");
9
10	//It makes sense to check the player for null (if there was no
11	//such player, for example), in order to avoid any exceptions
12	if(player != null){
13	//Attach the file browser to the screen of the player
14	player.addGuiElement(fileBrowser);
15	}

Example #2: Show "C:/Program Files/" folder

1	//Create a new file browser object
2	GuiFileBrowser fileBrowser = new GuiFileBrowser(0.5f, 0.5f, true, 0.6f, 0.4f, true);
3
4	//Change the directory to the "Blueprints" directory
5	fileBrowser.setDirectory(GuiFileBrowser.ROOT_DIR + "/Blueprints/");
6
7	//Now find a player (so you can attach the file browser to his screen)
8	Player player = getServer().getPlayer("MrPlow");
9
10	//It makes sense to check the player for null (if there was no
11	//such player, for example), in order to avoid any exceptions
12	if(player != null){
13	//Attach the file browser to the screen of the player
14	player.addGuiElement(fileBrowser);
15	}

getDefaultDirectory

public java.lang.String getDefaultDirectory()

Gets the default directory.

Returns:

the default directory.

getCurrentDirectory

public void getCurrentDirectory(Player player,
                                Callback<java.lang.String> callback)

Gets the current directory. Since this information needs to be queried from the client, this method uses a Callback.

Parameters:

player - the player you want to get this information from (since the gui element can be attached to several players simultaneously, it's necessary to specify the actual player).

callback - the Callback object. It will be called once the current directory has been retrieved from the player. It will be passed as argument.

setFileExtensionFilter

public void setFileExtensionFilter(java.lang.String... extension)

Sets a filter to show only files with the provided extension. For example, if you provide "jpg" and "png" as extensions, only .jpg and .png files will be visible in the file browser. Use null to remove any filters, so all files will be shown (default).

Parameters:

extension - the file extensions you want to restrict the file browser to. Provide null to remove all filters (so all files will be visible)

getFileExtensionFilter

public java.lang.String[] getFileExtensionFilter()

Gets the file extension filter (if set), i.e. an array of allowed file extension types. If no filter is set, this method returns null (by default, no filter is set).

Returns:

an array containing all file extension filters, or null if no filter is set.

setColor

public void setColor(int color)

Sets the background color for the file browser element. Default color is 0x00000000, i.e. black with full transparency (alpha = 0.0)

Overrides:

setColor in class GuiElement

Parameters:

color - an RGBA integer value which specifies the background color.

setColor

public void setColor(float r,
                     float g,
                     float b,
                     float a)

Sets the background color for the file browser element. Default color is (0.0, 0.0, 0.0, 0.0), i.e. black with full transparency (alpha = 0.0)

Overrides:

setColor in class GuiElement

Parameters:

r - the red color value (0-1)

g - the green color value (0-1)

b - the blue color value (0-1)

a - the alpha value (0-1), 0 makes the background invisible, 1 fully opaque.

setClickable

public void setClickable(boolean set)

isClickable

public boolean isClickable()

Overrides:

isClickable in class GuiElement

refresh

public void refresh()

Description copied from class: GuiElement

Refreshes this element, i.e. synchronizes it between the client and the server. There is no need to call this method manually.

Overrides:

refresh in class GuiElement

onFileSelect

public void onFileSelect(PlayerSelectFileEvent event)