org.bukkit.help

クラス IndexHelpTopic

java.lang.Object

org.bukkit.help.HelpTopic

org.bukkit.help.IndexHelpTopic

public class IndexHelpTopic
extends HelpTopic

This help topic generates a list of other help topics. This class is useful for adding your own index help topics. To enforce a particular order, use a sorted collection.

If a preamble is provided to the constructor, that text will be displayed before the first item in the index.

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
protected Collection<HelpTopic>	allTopics
protected String	permission
protected String	preamble

クラスから継承されたフィールド org.bukkit.help.HelpTopic

amendedPermission, fullText, name, shortText

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
IndexHelpTopic(String name, String shortText, String permission, Collection<HelpTopic> topics)
IndexHelpTopic(String name, String shortText, String permission, Collection<HelpTopic> topics, String preamble)

メソッドのサマリー

修飾子とタイプ	メソッドと説明
void	amendCanSee(String amendedPermission) Allows the server administrator to override the permission required to see a help topic.
protected String	buildIndexLine(CommandSender sender, HelpTopic topic) Builds individual lines in the index topic.
protected String	buildPreamble(CommandSender sender) Builds the topic preamble.
boolean	canSee(CommandSender sender) Determines if a Player is allowed to see this help topic.
String	getFullText(CommandSender sender) Returns the full description of this help topic that is displayed when the user requests this topic's details.
protected void	setTopicsCollection(Collection<HelpTopic> topics) Sets the contents of the internal allTopics collection.

クラスから継承されたメソッド org.bukkit.help.HelpTopic

amendTopic, applyAmendment, getName, getShortText

クラスから継承されたメソッド java.lang.Object

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

フィールドの詳細

permission

protected String permission

preamble

protected String preamble

allTopics

protected Collection<HelpTopic> allTopics

コンストラクタの詳細

IndexHelpTopic

public IndexHelpTopic(String name,
                      String shortText,
                      String permission,
                      Collection<HelpTopic> topics)

IndexHelpTopic

public IndexHelpTopic(String name,
                      String shortText,
                      String permission,
                      Collection<HelpTopic> topics,
                      String preamble)

メソッドの詳細

setTopicsCollection

protected void setTopicsCollection(Collection<HelpTopic> topics)

Sets the contents of the internal allTopics collection.

パラメータ:

topics - The topics to set.

canSee

public boolean canSee(CommandSender sender)

クラスからコピーされた説明: HelpTopic

Determines if a Player is allowed to see this help topic.

HelpTopic implementations should take server administrator wishes into account as set by the HelpTopic.amendCanSee(String) function.

定義:

canSee クラス内 HelpTopic

パラメータ:

sender - The Player in question.

戻り値:

True of the Player can see this help topic, false otherwise.

amendCanSee

public void amendCanSee(String amendedPermission)

クラスからコピーされた説明: HelpTopic

Allows the server administrator to override the permission required to see a help topic.

HelpTopic implementations should take this into account when determining topic visibility on the HelpTopic.canSee(org.bukkit.command.CommandSender) function.

オーバーライド:

amendCanSee クラス内 HelpTopic

パラメータ:

amendedPermission - The permission node the server administrator wishes to apply to this topic.

getFullText

public String getFullText(CommandSender sender)

クラスからコピーされた説明: HelpTopic

Returns the full description of this help topic that is displayed when the user requests this topic's details.

The result will be paginated to properly fit the user's client.

オーバーライド:

getFullText クラス内 HelpTopic

パラメータ:

sender - The player or console requesting the full text. Useful for further security trimming the command's full text based on sub-permissions in custom implementations.

戻り値:

A full topic description.

buildPreamble

protected String buildPreamble(CommandSender sender)

Builds the topic preamble. Override this method to change how the index preamble looks.

パラメータ:

sender - The command sender requesting the preamble.

戻り値:

The topic preamble.

buildIndexLine

protected String buildIndexLine(CommandSender sender,
                                HelpTopic topic)

Builds individual lines in the index topic. Override this method to change how index lines are rendered.

パラメータ:

sender - The command sender requesting the index line.

topic - The topic to render into an index line.

戻り値:

The rendered index line.