com.mindlin.clientBridge.api

Class CustomGUI

java.lang.Object

com.mindlin.clientBridge.api.CustomGUI

All Implemented Interfaces:

JSONifiable

public class CustomGUI
extends Object
implements JSONifiable

A custom GUI that can be sent to the client from this plugin.
Yes, you *can* access a lot of variables, but it's generally a bad idea to change
them unless you understand exactly what they do.

Author:

mailmindlin

Field Summary

Fields

Modifier and Type	Field and Description
ArrayList<DrawCommand>	backgroundCommands A list of DrawCommands that are drawn first.
static HashMap<String,CustomGUI>	clientRegister Map of registered GUIs.
ArrayList<GuiButton>	controlList Deprecated.
ArrayList<DrawCommand>	initCommands A list of DrawCommands that are drawn second.
static int	lastIndex Integer that stores the last GUI_ID, to prevent mismatches
static HashMap<Integer,String>	registerIndex Map of GUI_ID to GUI names
ServerInterface	serverInterface Server interface of GUI.

Constructor Summary

Constructors

Constructor and Description
CustomGUI()

Method Summary

Methods

Modifier and Type	Method and Description
void	addEventListener(GUIListener handler)
boolean	build(JSONObject json)
boolean	build(String s) Build itself such that for Object o that implements JSONifiable, the following conditions will be true: o.build(o.serialize(false))==o o.build(o.serialize(true))==o
void	callEvent(ClientGuiEvent ev)
static CustomGUI	getActiveGUI(int index) Returns the gui given its GUI_ID Nonexistent GUIs return false; Only retrieves registered guis.
static CustomGUI	getActiveGUI(String name) Returns the gui, given its name.
GuiButton	getButtonById(int id) Deprecated.
static CustomGUI	getGUI(String name) Returns a GUI, given its name.
int	getIndex() Returns the GUI_ID.
String	getName() Returns the registered name of the GUI.
void	initGui() super commands
static boolean	isRegistered(int index) Returns whether the given index is registered.
static boolean	isRegistered(String name) Returns whether the given name is registered.
void	log(String s) Logs s to console.
void	register()
static void	register(CustomGUI gui, String name) Registeres gui with to string name. Puts gui into clientRegister
JSONObject	serialize(boolean compress) Serialization, as specified in JSONifiable.serialize(boolean)
static void	showGui(int index, BridgePlayer player) Shows a guiof given index to BridgePlayer p.
static void	showGui(String name, BridgePlayer player) Shows a registered GUI of given name to BridgePlayer p.
JSONObject	toJSON() Deprecated.

Methods inherited from class java.lang.Object

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

Field Detail

clientRegister

public static HashMap<String,CustomGUI> clientRegister

Map of registered GUIs. The key is the GUI name.

registerIndex

public static HashMap<Integer,String> registerIndex

Map of GUI_ID to GUI names

lastIndex

public static int lastIndex

Integer that stores the last GUI_ID, to prevent mismatches

backgroundCommands

public ArrayList<DrawCommand> backgroundCommands

A list of DrawCommands that are drawn first.

initCommands

public ArrayList<DrawCommand> initCommands

A list of DrawCommands that are drawn second.

controlList

@Deprecated
public ArrayList<GuiButton> controlList

Deprecated.

serverInterface

public ServerInterface serverInterface

Server interface of GUI. Controls which events are sent to server.

Constructor Detail

CustomGUI

public CustomGUI()

Method Detail

getGUI

public static CustomGUI getGUI(String name)

Returns a GUI, given its name.

Parameters:

name -

Returns:

GUI

isRegistered

public static boolean isRegistered(String name)

Returns whether the given name is registered.

Parameters:

name -

Returns:

if name is registered

isRegistered

public static boolean isRegistered(int index)

Returns whether the given index is registered.

Parameters:

index -

Returns:

if index is registered

register

public static void register(CustomGUI gui,
            String name)

Registeres gui with to string name.
Puts gui into clientRegister

Parameters:

gui -

name -

showGui

public static void showGui(String name,
           BridgePlayer player)

Shows a registered GUI of given name to BridgePlayer p.

Parameters:

name -

player -

showGui

public static void showGui(int index,
           BridgePlayer player)

Shows a guiof given index to BridgePlayer p.

Parameters:

index -

player -

getActiveGUI

public static CustomGUI getActiveGUI(int index)

Returns the gui given its GUI_ID Nonexistent GUIs return false; Only retrieves registered guis.

Parameters:

index -

Returns:

Active GUI

getActiveGUI

public static CustomGUI getActiveGUI(String name)

Returns the gui, given its name. Nonexistent GUIs return false;

Parameters:

name -

Returns:

Active GUI

register

public void register()

getName

public String getName()

Returns the registered name of the GUI. Only if GUI has been registered with CustomGUI.register(this,name)

Returns:

GUI name

getIndex

public int getIndex()

Returns the GUI_ID. If not registered, attempts to register self.

Returns:

GUI_ID

log

public void log(String s)

Logs s to console.

Parameters:

s -

initGui

public void initGui()

super commands

getButtonById

@Deprecated
public GuiButton getButtonById(int id)

Deprecated.

toJSON

@Deprecated
public JSONObject toJSON()

Deprecated.

Converts GUI into JSON object, to send to client.
Replaced by serialize(boolean)

Returns:

JSON representation of GUI

See Also:

serialize(boolean)

build

public boolean build(String s)

Description copied from interface: JSONifiable

Build itself such that for Object o that implements JSONifiable, the following conditions will be true:
o.build(o.serialize(false))==o
o.build(o.serialize(true))==o

Specified by:

build in interface JSONifiable

Parameters:

s - (JSON string from serialize())

Returns:

success (of building)

build

public boolean build(JSONObject json)

Specified by:

build in interface JSONifiable

serialize

public JSONObject serialize(boolean compress)

Serialization, as specified in JSONifiable.serialize(boolean)

Specified by:

serialize in interface JSONifiable

Parameters:

compress -

Returns:

Serialized object

addEventListener

public void addEventListener(GUIListener handler)

callEvent

public void callEvent(ClientGuiEvent ev)