com.germ.germplugin.api.dynamic.gui

Class GermGuiScreen

java.lang.Object

com.germ.germplugin.api.dynamic.gui.GermGuiScreen

All Implemented Interfaces:

IGuiPartContainer, java.lang.Cloneable

public class GermGuiScreen
extends java.lang.Object
implements IGuiPartContainer, java.lang.Cloneable

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GermGuiScreen.ClickType 点击类型
static class	GermGuiScreen.ScreenLevel
static class	GermGuiScreen.ScreenType

Constructor Summary

Constructors

Modifier	Constructor and Description
	GermGuiScreen(java.lang.String guiName) 新建一个界面
protected	GermGuiScreen(java.lang.String guiName, boolean addOptions)
protected	GermGuiScreen(java.lang.String guiName, org.bukkit.configuration.ConfigurationSection srcSection)

Method Summary

Modifier and Type	Method and Description
void	addChildGuiScreen(GermGuiScreen germGuiScreen)
void	addGuiPart(GermGuiPart<? extends DynamicBase> germGuiPart) 添加部件 在任何时候都有效
void	addReceivePost(java.lang.String path, IGuiScreenPostHandler guiScreenPostHandler)
void	clearGuiPart()
GermGuiScreen	clone()
void	close()
void	closeGui() Deprecated. 使用 close()
void	closeGuiChild() Deprecated. 使用 close()
void	closeHud() Deprecated. 使用 close()
boolean	equals(java.lang.Object o)
<T extends GermGuiPart<? extends DynamicBase>> java.util.List<T>	getAllGuiParts(java.lang.Class<T> primitivePartClass)
java.util.List<GermGuiScreen>	getChildGuiScreens()
IGuiScreenHandler	getClosedHandler()
static GermGuiScreen	getGermGuiScreen(java.lang.String guiName) 新建一个空界面
static GermGuiScreen	getGermGuiScreen(java.lang.String guiName, org.bukkit.configuration.ConfigurationSection configurationSection) 直接将yml内的配置文件转化为界面
static GermGuiScreen	getGermGuiScreen(java.lang.String guiName, java.lang.String indexName, org.bukkit.configuration.file.YamlConfiguration yamlConfiguration)
static GermGuiScreen	getGermGuiScreen(java.lang.String indexName, org.bukkit.configuration.file.YamlConfiguration yamlConfiguration)
java.lang.String	getGuiName() 界面的名字
GermGuiPart<? extends DynamicBase>	getGuiPart(java.lang.String indexName) 根据索引名获取部件 如果要获取组件内部的某个组件，例如滚动框A内的组件B 那么要写 getGuiPart("A$B") 如果组件B又是一个可以包含其他组件的组件，例如包含了C 那么就是 getGuiPart("A$B$C")
<T extends GermGuiPart<? extends DynamicBase>> T	getGuiPart(java.lang.String indexName, java.lang.Class<T> primitivePartClass) 根据索引名获取部件 如果要获取组件内部的某个组件，例如滚动框A内的组件B 那么要写 getGuiPart("A$B") 如果组件B又是一个可以包含其他组件的组件，例如包含了C 那么就是 getGuiPart("A$B$C")
java.util.List<GermGuiPart<? extends DynamicBase>>	getGuiParts() 获得界面的GUI部件列表
<T extends GermGuiPart<? extends DynamicBase>> @NotNull java.util.List<T>	getGuiParts(java.lang.Class<T> primitivePartClass) 根据类型获取部件
GermGuiSlot	getGuiSlotFromIdentity(java.lang.String slotIdentity)
IGuiScreenHandler	getKeyDownHandler(int key) Deprecated.
IGuiScreenHandler	getKeyDownHandler(KeyType keyType)
MappingType	getMappingType()
GermGuiScreen	getNextGuiScreen()
IGuiScreenHandler	getOpenedHandler()
@NotNull GermGuiOptions	getOptions()
GermGuiScreen	getParentGuiScreen()
org.bukkit.entity.Player	getPlayer()
GermGuiScreen	getPreGuiScreen()
org.bukkit.configuration.ConfigurationSection	getPrivateConfig()
org.bukkit.entity.Player	getReadyPlayer()
GermGuiScreen.ScreenLevel	getScreenLevel()
GermGuiScreen.ScreenType	getScreenType()
SimpleMap	getSimpleMap()
org.bukkit.configuration.file.YamlConfiguration	getSrc() 获得 GUI界面的源码
int	hashCode()
boolean	isInvalid()
boolean	isOpened() 界面是否是被打开的 在刚调用open方法时，服务端会告诉客户端打开界面 当客户端打开界面后，此方法才会返回opened=true
boolean	isReadyOpen() 在刚调用open时如果要检测是否正在打开界面的途中 调用该方法
void	loadSrc(org.bukkit.configuration.ConfigurationSection configurationSection)
void	loadSrc(java.lang.String frontIndexName, org.bukkit.configuration.ConfigurationSection configurationSection)
void	onClosed()
void	onOpened()
void	onReceivePost(java.lang.String path, java.util.Map<java.lang.String,java.lang.Object> contentMap, java.util.Map<java.lang.String,java.lang.Object> responseMap)
void	openChildGui(org.bukkit.entity.Player player) 以子窗口的形式为玩家打开界面 前提是玩家已经有父界面了
void	openGui(org.bukkit.entity.Player player) 以GUI的形式为玩家打开界面
void	openHud(org.bukkit.entity.Player player) 用HUD的形式为玩家打开界面
void	openToEntity(@NotNull org.bukkit.entity.Player player, @NotNull org.bukkit.entity.Entity entity, @NotNull GermEffectGui germEffectGui) 让一个GUI界面跟着这个实体
void	openToLocation(org.bukkit.entity.Player player, org.bukkit.Location location, GermEffectGui germEffectGui) 让一个GUI界面打开在世界某处
void	post(java.lang.String path, java.util.Map responseMap) 主动向客户端发送 会触发客户端的responseScript
void	registerKeyDownHandler(int key, IGuiScreenHandler guiScreenHandler) Deprecated.
void	registerKeyDownHandler(KeyType keyType, IGuiScreenHandler guiScreenHandler)
static void	registerMappingType(java.lang.String guiName, MappingType mappingType)
void	removeChildGuiScreen(GermGuiScreen germGuiScreen)
void	removeGuiPart(GermGuiPart<? extends DynamicBase> germGuiPart) 删除一个组件
void	removeGuiPart(java.lang.String indexName) 根据名字删除部件 在任何时候都有效
void	removeReceivePost(java.lang.String path)
void	sendDos(java.util.List<java.lang.String> dos) 在界面处于readyOpen 或者opened的情况下调用才有效
void	sendDos(java.lang.String... dos) 在界面处于readyOpen 或者opened的情况下调用才有效
void	sendRunDos(java.lang.String dosName, java.lang.String... dos) 在界面处于readyOpen 或者opened的情况下调用才有效 用法详情请搜索GermPlugin/gui/default.yml中的run dos
void	setChildGuiScreens(java.util.List<GermGuiScreen> childGuiScreens)
void	setClosedHandler(IGuiScreenHandler closedHandler)
GermGuiScreen	setGuiName(java.lang.String guiName)
void	setInvalid(boolean flag) 将界面内所有可以 IGuiPartInteractive 的组件有效/无效化 包括子组件
void	setMappingType(MappingType mappingType)
void	setNextGuiScreen(GermGuiScreen nextGuiScreen)
void	setOpened(org.bukkit.entity.Player player) Deprecated.
void	setOpenedHandler(IGuiScreenHandler openedHandler)
void	setParentGuiScreen(GermGuiScreen parentGuiScreen)
void	setPreGuiScreen(GermGuiScreen preGuiScreen)
protected void	setPrivateConfig(org.bukkit.configuration.ConfigurationSection privateConfig)
void	setReadyPlayer(org.bukkit.entity.Player readyPlayer)
void	setScreenLevel(GermGuiScreen.ScreenLevel screenLevel)
void	setScreenType(GermGuiScreen.ScreenType screenType)
void	sortGuiPart(java.util.Comparator<GermGuiPart<? extends DynamicBase>> comparator)
java.lang.String	toString()
static void	unregisterMappingType(java.lang.String guiName)

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GermGuiScreen

public GermGuiScreen(java.lang.String guiName)

新建一个界面

Parameters:

guiName - 界面名字

GermGuiScreen

protected GermGuiScreen(java.lang.String guiName,
                        boolean addOptions)

GermGuiScreen

protected GermGuiScreen(java.lang.String guiName,
                        org.bukkit.configuration.ConfigurationSection srcSection)

Method Detail

clone

public GermGuiScreen clone()

Overrides:

clone in class java.lang.Object

setMappingType

public void setMappingType(MappingType mappingType)

Specified by:

setMappingType in interface IGuiPartContainer

getMappingType

public MappingType getMappingType()

Specified by:

getMappingType in interface IGuiPartContainer

registerMappingType

public static void registerMappingType(java.lang.String guiName,
                                       MappingType mappingType)

unregisterMappingType

public static void unregisterMappingType(java.lang.String guiName)

setGuiName

public GermGuiScreen setGuiName(java.lang.String guiName)

getSimpleMap

public SimpleMap getSimpleMap()

setInvalid

public void setInvalid(boolean flag)

将界面内所有可以 IGuiPartInteractive 的组件有效/无效化 包括子组件

Parameters:

flag -

sendRunDos

public void sendRunDos(java.lang.String dosName,
                       java.lang.String... dos)

在界面处于readyOpen 或者opened的情况下调用才有效

用法详情请搜索GermPlugin/gui/default.yml中的run dos

Parameters:

dos -

sendDos

public void sendDos(java.lang.String... dos)

在界面处于readyOpen 或者opened的情况下调用才有效

Parameters:

dos -

sendDos

public void sendDos(java.util.List<java.lang.String> dos)

在界面处于readyOpen 或者opened的情况下调用才有效

Parameters:

dos -

addGuiPart

public void addGuiPart(GermGuiPart<? extends DynamicBase> germGuiPart)

添加部件
在任何时候都有效

Specified by:

addGuiPart in interface IGuiPartContainer

Parameters:

germGuiPart - 部件

removeGuiPart

public void removeGuiPart(GermGuiPart<? extends DynamicBase> germGuiPart)

删除一个组件

Specified by:

removeGuiPart in interface IGuiPartContainer

Parameters:

germGuiPart -

removeGuiPart

public void removeGuiPart(java.lang.String indexName)

根据名字删除部件
在任何时候都有效

Specified by:

removeGuiPart in interface IGuiPartContainer

Parameters:

indexName - 部件的索引名

clearGuiPart

public void clearGuiPart()

Specified by:

clearGuiPart in interface IGuiPartContainer

getGuiPart

public GermGuiPart<? extends DynamicBase> getGuiPart(java.lang.String indexName)

根据索引名获取部件
如果要获取组件内部的某个组件，例如滚动框A内的组件B 那么要写 getGuiPart("A$B") 如果组件B又是一个可以包含其他组件的组件，例如包含了C 那么就是 getGuiPart("A$B$C")

Specified by:

getGuiPart in interface IGuiPartContainer

Parameters:

indexName - 部件索引名

getGuiPart

public <T extends GermGuiPart<? extends DynamicBase>> T getGuiPart(java.lang.String indexName,
                                                                   java.lang.Class<T> primitivePartClass)

根据索引名获取部件
如果要获取组件内部的某个组件，例如滚动框A内的组件B 那么要写 getGuiPart("A$B") 如果组件B又是一个可以包含其他组件的组件，例如包含了C 那么就是 getGuiPart("A$B$C")

Specified by:

getGuiPart in interface IGuiPartContainer

Type Parameters:

T - 组件

Parameters:

indexName - 索引名

primitivePartClass - 要获取组件的类 这样就不用强转了

Returns:

sortGuiPart

public void sortGuiPart(java.util.Comparator<GermGuiPart<? extends DynamicBase>> comparator)

Specified by:

sortGuiPart in interface IGuiPartContainer

getGuiParts

public java.util.List<GermGuiPart<? extends DynamicBase>> getGuiParts()

获得界面的GUI部件列表

Specified by:

getGuiParts in interface IGuiPartContainer

Returns:

registerKeyDownHandler

@Deprecated
public void registerKeyDownHandler(int key,
                                                IGuiScreenHandler guiScreenHandler)

Deprecated.

Parameters:

key - 按键数字ID

guiScreenHandler - 当在该界面按下Key时调用

registerKeyDownHandler

public void registerKeyDownHandler(KeyType keyType,
                                   IGuiScreenHandler guiScreenHandler)

Parameters:

keyType - KeyType

guiScreenHandler - 当在该界面按下Key时调用

getKeyDownHandler

@Deprecated
public IGuiScreenHandler getKeyDownHandler(int key)

Deprecated.

getKeyDownHandler

public IGuiScreenHandler getKeyDownHandler(KeyType keyType)

getGuiParts

@NotNull
public <T extends GermGuiPart<? extends DynamicBase>> @NotNull java.util.List<T> getGuiParts(java.lang.Class<T> primitivePartClass)

根据类型获取部件

Specified by:

getGuiParts in interface IGuiPartContainer

getGuiSlotFromIdentity

@Nullable
public GermGuiSlot getGuiSlotFromIdentity(java.lang.String slotIdentity)

Specified by:

getGuiSlotFromIdentity in interface IGuiPartContainer

Returns:

通过slotIdentity获取对应的slot
包括子容器内
如果没有则返回null

getAllGuiParts

public <T extends GermGuiPart<? extends DynamicBase>> java.util.List<T> getAllGuiParts(java.lang.Class<T> primitivePartClass)

Specified by:

getAllGuiParts in interface IGuiPartContainer

Returns:

所有的指定类型组件
包括子容器内

getOptions

@NotNull
public @NotNull GermGuiOptions getOptions()

isOpened

public boolean isOpened()

界面是否是被打开的
在刚调用open方法时，服务端会告诉客户端打开界面
当客户端打开界面后，此方法才会返回opened=true

Returns:

isReadyOpen

public boolean isReadyOpen()

在刚调用open时如果要检测是否正在打开界面的途中
调用该方法

Returns:

setOpened

@Deprecated
public void setOpened(org.bukkit.entity.Player player)

Deprecated.

addChildGuiScreen

public void addChildGuiScreen(GermGuiScreen germGuiScreen)

removeChildGuiScreen

public void removeChildGuiScreen(GermGuiScreen germGuiScreen)

openGui

public void openGui(org.bukkit.entity.Player player)

以GUI的形式为玩家打开界面

Parameters:

player - 玩家

openChildGui

public void openChildGui(org.bukkit.entity.Player player)

以子窗口的形式为玩家打开界面
前提是玩家已经有父界面了

Parameters:

player - 玩家

openHud

public void openHud(org.bukkit.entity.Player player)

用HUD的形式为玩家打开界面

Parameters:

player -

openToEntity

public void openToEntity(@NotNull
                         @NotNull org.bukkit.entity.Player player,
                         @NotNull
                         @NotNull org.bukkit.entity.Entity entity,
                         @NotNull
                         @NotNull GermEffectGui germEffectGui)

让一个GUI界面跟着这个实体

Parameters:

player - 玩家

entity - 实体必须与player相同世界

germEffectGui - 包含特殊信息的实例 GermEffectGui

openToLocation

public void openToLocation(org.bukkit.entity.Player player,
                           org.bukkit.Location location,
                           GermEffectGui germEffectGui)

让一个GUI界面打开在世界某处

Parameters:

player - 玩家

location - 必须与玩家相同世界

germEffectGui - 包含特殊信息的实例 GermEffectGui

close

public void close()

closeGuiChild

@Deprecated
public void closeGuiChild()

Deprecated. 使用 close()

以子界面的形式关闭界面

closeGui

@Deprecated
public void closeGui()

Deprecated. 使用 close()

以窗口的形式关闭界面界面

closeHud

@Deprecated
public void closeHud()

Deprecated. 使用 close()

以HUD的形式关闭界面

addReceivePost

public void addReceivePost(java.lang.String path,
                           IGuiScreenPostHandler guiScreenPostHandler)

removeReceivePost

public void removeReceivePost(java.lang.String path)

onReceivePost

public void onReceivePost(java.lang.String path,
                          java.util.Map<java.lang.String,java.lang.Object> contentMap,
                          java.util.Map<java.lang.String,java.lang.Object> responseMap)

post

public void post(java.lang.String path,
                 java.util.Map responseMap)

主动向客户端发送 会触发客户端的responseScript

onClosed

public void onClosed()

onOpened

public void onOpened()

getSrc

public org.bukkit.configuration.file.YamlConfiguration getSrc()

获得 GUI界面的源码

Returns:

GUI 的源码数据

loadSrc

public void loadSrc(java.lang.String frontIndexName,
                    org.bukkit.configuration.ConfigurationSection configurationSection)

loadSrc

public void loadSrc(org.bukkit.configuration.ConfigurationSection configurationSection)

getGermGuiScreen

public static GermGuiScreen getGermGuiScreen(java.lang.String guiName)

新建一个空界面

Parameters:

guiName -

Returns:

getGermGuiScreen

public static GermGuiScreen getGermGuiScreen(java.lang.String indexName,
                                             org.bukkit.configuration.file.YamlConfiguration yamlConfiguration)

Parameters:

indexName - 界面配置在 yamlConfiguration 中的索引节点名 并且作为构建出来的界面名字

yamlConfiguration - Yaml实例

Returns:

界面实例

getGermGuiScreen

public static GermGuiScreen getGermGuiScreen(java.lang.String guiName,
                                             java.lang.String indexName,
                                             org.bukkit.configuration.file.YamlConfiguration yamlConfiguration)

Parameters:

guiName - 界面名字

indexName - 界面在 yamlConfiguration 中的索引位置

yamlConfiguration - Yaml实例

Returns:

界面实例

getGermGuiScreen

public static GermGuiScreen getGermGuiScreen(java.lang.String guiName,
                                             org.bukkit.configuration.ConfigurationSection configurationSection)

直接将yml内的配置文件转化为界面

Parameters:

guiName - GUI的名字

configurationSection - 界面的配置

Returns:

界面实例

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getGuiName

public java.lang.String getGuiName()

界面的名字

isInvalid

public boolean isInvalid()

setParentGuiScreen

public void setParentGuiScreen(GermGuiScreen parentGuiScreen)

getParentGuiScreen

public GermGuiScreen getParentGuiScreen()

setNextGuiScreen

public void setNextGuiScreen(GermGuiScreen nextGuiScreen)

getNextGuiScreen

public GermGuiScreen getNextGuiScreen()

setPreGuiScreen

public void setPreGuiScreen(GermGuiScreen preGuiScreen)

getPreGuiScreen

public GermGuiScreen getPreGuiScreen()

getPrivateConfig

public org.bukkit.configuration.ConfigurationSection getPrivateConfig()

setPrivateConfig

protected void setPrivateConfig(org.bukkit.configuration.ConfigurationSection privateConfig)

setScreenType

public void setScreenType(GermGuiScreen.ScreenType screenType)

getScreenType

public GermGuiScreen.ScreenType getScreenType()

getClosedHandler

public IGuiScreenHandler getClosedHandler()

setClosedHandler

public void setClosedHandler(IGuiScreenHandler closedHandler)

getOpenedHandler

public IGuiScreenHandler getOpenedHandler()

setOpenedHandler

public void setOpenedHandler(IGuiScreenHandler openedHandler)

setReadyPlayer

public void setReadyPlayer(org.bukkit.entity.Player readyPlayer)

getReadyPlayer

public org.bukkit.entity.Player getReadyPlayer()

getPlayer

public org.bukkit.entity.Player getPlayer()

getChildGuiScreens

public java.util.List<GermGuiScreen> getChildGuiScreens()

setChildGuiScreens

public void setChildGuiScreens(java.util.List<GermGuiScreen> childGuiScreens)

getScreenLevel

public GermGuiScreen.ScreenLevel getScreenLevel()

setScreenLevel

public void setScreenLevel(GermGuiScreen.ScreenLevel screenLevel)