1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
|
package org.bukkit.help;
import org.bukkit.ChatColor;
import org.bukkit.command.CommandSender;
import org.bukkit.command.ConsoleCommandSender;
import org.bukkit.entity.Player;
import org.bukkit.util.ChatPaginator;
import java.util.Collection;
/**
* 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.
* <p>
* If a preamble is provided to the constructor, that text will be displayed
* before the first item in the index.
*/
public class IndexHelpTopic extends HelpTopic {
protected String permission;
protected String preamble;
protected Collection<HelpTopic> allTopics;
public IndexHelpTopic(String name, String shortText, String permission, Collection<HelpTopic> topics) {
this(name, shortText, permission, topics, null);
}
public IndexHelpTopic(String name, String shortText, String permission, Collection<HelpTopic> topics, String preamble) {
this.name = name;
this.shortText = shortText;
this.permission = permission;
this.preamble = preamble;
setTopicsCollection(topics);
}
/**
* Sets the contents of the internal allTopics collection.
*
* @param topics The topics to set.
*/
protected void setTopicsCollection(Collection<HelpTopic> topics) {
this.allTopics = topics;
}
public boolean canSee(CommandSender sender) {
if (sender instanceof ConsoleCommandSender) {
return true;
}
if (permission == null) {
return true;
}
return sender.hasPermission(permission);
}
@Override
public void amendCanSee(String amendedPermission) {
permission = amendedPermission;
}
public String getFullText(CommandSender sender) {
StringBuilder sb = new StringBuilder();
if (preamble != null) {
sb.append(buildPreamble(sender));
sb.append("\n");
}
for (HelpTopic topic : allTopics) {
if (topic.canSee(sender)) {
String lineStr = buildIndexLine(sender, topic).replace("\n", ". ");
if (sender instanceof Player && lineStr.length() > ChatPaginator.GUARANTEED_NO_WRAP_CHAT_PAGE_WIDTH) {
sb.append(lineStr.substring(0, ChatPaginator.GUARANTEED_NO_WRAP_CHAT_PAGE_WIDTH - 3));
sb.append("...");
} else {
sb.append(lineStr);
}
sb.append("\n");
}
}
return sb.toString();
}
/**
* Builds the topic preamble. Override this method to change how the index
* preamble looks.
*
* @param sender The command sender requesting the preamble.
* @return The topic preamble.
*/
protected String buildPreamble(CommandSender sender) {
return ChatColor.GRAY + preamble;
}
/**
* Builds individual lines in the index topic. Override this method to
* change how index lines are rendered.
*
* @param sender The command sender requesting the index line.
* @param topic The topic to render into an index line.
* @return The rendered index line.
*/
protected String buildIndexLine(CommandSender sender, HelpTopic topic) {
StringBuilder line = new StringBuilder();
line.append(ChatColor.GOLD);
line.append(topic.getName());
line.append(": ");
line.append(ChatColor.WHITE);
line.append(topic.getShortText());
return line.toString();
}
}
|
