com.leafdigital.ircui.api
Class IRCActionListMsg
java.lang.Object
leafchat.core.api.Msg
com.leafdigital.ircui.api.IRCActionListMsg
public class IRCActionListMsg
- extends Msg
Message that is sent when building a list of actions, for example when somebody
right-clicks on a nickname or the like. Receivers should call
addIRCAction(IRCAction)
if they have a possible action that
applies in that context.
Constructor Summary |
IRCActionListMsg(Server server,
java.lang.String contextChannel,
java.lang.String contextNick,
java.lang.String selectedChannel,
java.lang.String[] selectedNicks)
|
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
IRCActionListMsg
public IRCActionListMsg(Server server,
java.lang.String contextChannel,
java.lang.String contextNick,
java.lang.String selectedChannel,
java.lang.String[] selectedNicks)
- Parameters:
server
- Server of window this message is forcontextChannel
- Context channelcontextNick
- Context nicknameselectedChannel
- Channel of window this message is for; null if it's not a chanselectedNicks
- Nicknames this message is for; null if none
getIRCActions
public java.util.Collection<IRCAction> getIRCActions()
- For use by whoever despatched the message, after its despatch.
- Returns:
- All the actions that were added
addIRCAction
public void addIRCAction(IRCAction a)
- Adds an action to the list.
- Parameters:
a
- Action
hasSingleNick
public boolean hasSingleNick()
- Returns:
- True if the action list refers to a nickname (either selected or context)
notUs
public boolean notUs()
- Returns:
- True if a single nickname, or any of multiple nicknames, is not
the current user's
hasSelectedNicks
public boolean hasSelectedNicks()
- Returns:
- True if there are a number of selected (not context) nicknames
getSingleNick
public java.lang.String getSingleNick()
- Returns:
- Single nickname
getSelectedNicks
public java.lang.String[] getSelectedNicks()
- Returns:
- Array of nicknames
getContextNick
public java.lang.String getContextNick()
- Returns:
- Context nick (e.g. in a message window)
hasChannel
public boolean hasChannel()
- Returns:
- True if the action list refers to a channel
getChannel
public java.lang.String getChannel()
- Returns:
- Channel (either selected or context)
getContextChannel
public java.lang.String getContextChannel()
- Returns:
- Context channel (e.g. in a channel window)
getSelectedChannel
public java.lang.String getSelectedChannel()
- Returns:
- Selected channel e.g. if clicked on
getServer
public Server getServer()
- Returns:
- Server
Copyright © 2011 Samuel Marshall. All rights reserved.