Package VASSAL.chat.ui

Class ChatServerControls

java.lang.Object

VASSAL.search.AbstractImageFinder

VASSAL.build.AbstractBuildable

VASSAL.chat.ui.ChatServerControls

All Implemented Interfaces:

Buildable, PropertyNameSource, ValidityChecker, ImageSearchTarget

public class ChatServerControls
extends AbstractBuildable

Field Summary

Fields

Modifier and Type	Field	Description
protected BasicChatControlsInitializer	basicControls
protected ChatServerConnection	client
protected JButton	configServerButton
protected String	configServerText
protected JPanel	controlPanel
protected RoomTree	currentRoom
protected JButton	launch
protected JTextField	newRoom
protected JButton	newRoomButton
protected JLabel	newRoomLabel
protected ChatControlsInitializer	oldClient
protected RoomTree	roomTree
protected SplitPane	splitPane
protected ComponentSplitter.SplitPane	splitter	Deprecated, for removal: This API element is subject to removal in a future version.
protected JToolBar	toolbar

Fields inherited from class VASSAL.build.AbstractBuildable

buildComponents, validator

Constructor Summary

Constructors

Constructor	Description
ChatServerControls()

Method Summary

Modifier and Type	Method	Description
void	addExtendedNewRoomHandler(ActionListener l)
void	addTo(Buildable b)	Adds this component to its parent.
String[]	getAttributeNames()	Lists all the buildFile (XML) attribute names for this component.
String	getAttributeValueString(String name)
ChatServerConnection	getClient()
JPanel	getControls()
RoomTree	getCurrentRoom()
Component	getExtendedControls()
JTextField	getNewRoom()
RoomTree	getRoomTree()
JToolBar	getToolbar()
void	removeExtendedNewRoomHandler(ActionListener l)
void	setAttribute(String name, Object value)	Sets a buildFile (XML) attribute value for this component.
void	setClient(ChatServerConnection c)
void	setRoomControlsVisible(boolean visible)
void	toggleVisible()
void	updateClientDisplay(Icon icon, String text)

Methods inherited from class VASSAL.build.AbstractBuildable

add, addImageNamesRecursively, build, getAllDescendantComponents, getAllDescendantComponentsOf, getBuildables, getBuildComponents, getBuildElement, getComponents, getComponentsOf, getPropertyNames, validate

Methods inherited from class VASSAL.search.AbstractImageFinder

addLocalImageNames, getAllImageNames, getLocalImageNames

Methods inherited from class java.lang.Object

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

Field Details

currentRoom

protected RoomTree currentRoom

newRoom

protected JTextField newRoom

newRoomLabel

protected JLabel newRoomLabel

toolbar

protected JToolBar toolbar

roomTree

protected RoomTree roomTree

newRoomButton

protected JButton newRoomButton

launch

protected JButton launch

client

protected ChatServerConnection client

controlPanel

protected JPanel controlPanel

oldClient

protected ChatControlsInitializer oldClient

basicControls

protected BasicChatControlsInitializer basicControls

configServerButton

protected JButton configServerButton

configServerText

protected String configServerText

splitter

@Deprecated(since="2020-11-15",
            forRemoval=true)
protected ComponentSplitter.SplitPane splitter

Deprecated, for removal: This API element is subject to removal in a future version.

splitPane

protected SplitPane splitPane

Constructor Details

ChatServerControls

public ChatServerControls()

Method Details

updateClientDisplay

public void updateClientDisplay(Icon icon,
 String text)

getExtendedControls

public Component getExtendedControls()

addTo

public void addTo(Buildable b)

Description copied from interface: Buildable

Adds this component to its parent. In order to make Buildable objects extensible, the child is responsible for adding itself to the parent. That way, Buildable subcomponents can be defined in an extension package without needing to modify the containing class.

Parameters:

b - parent Buildable to add this component to as a subcomponent.

toggleVisible

public void toggleVisible()

getControls

public JPanel getControls()

setClient

public void setClient(ChatServerConnection c)

getClient

public ChatServerConnection getClient()

getAttributeNames

public String[] getAttributeNames()

Description copied from class: AbstractBuildable

Lists all the buildFile (XML) attribute names for this component. If this component is ALSO an AbstractConfigurable, then this list of attributes determines the appropriate attribute order for AbstractConfigurable.getAttributeDescriptions() and AbstractConfigurable.getAttributeTypes().

Specified by:

getAttributeNames in class AbstractBuildable

Returns:

a list of all buildFile (XML) attribute names for this component

setAttribute

public void setAttribute(String name,
 Object value)

Description copied from class: AbstractBuildable

Sets a buildFile (XML) attribute value for this component. The key parameter will be one of those listed in AbstractBuildable.getAttributeNames(). If the value parameter is a String, it will be the value returned by AbstractBuildable.getAttributeValueString(java.lang.String) for the same key. If the implementing class extends AbstractConfigurable, then value will be an instance of the corresponding Class listed in AbstractConfigurable.getAttributeTypes()

Specified by:

setAttribute in class AbstractBuildable

Parameters:

name - the name of the attribute. Will be one of those listed in AbstractBuildable.getAttributeNames()

value - If the value parameter is a String, it will be the value returned by AbstractBuildable.getAttributeValueString(java.lang.String) for the same key. If the implementing class extends AbstractConfigurable, then value can also be an instance of the corresponding Class listed in AbstractConfigurable.getAttributeTypes()

getAttributeValueString

public String getAttributeValueString(String name)

Specified by:

getAttributeValueString in class AbstractBuildable

Parameters:

name - the name of the attribute. Will be one of those listed in AbstractBuildable.getAttributeNames()

Returns:

a String representation of the XML buildFile attribute with the given name. When initializing a module, this String value will loaded from the XML and passed to AbstractBuildable.setAttribute(java.lang.String, java.lang.Object). It is also frequently used for checking the current value of an attribute.

getToolbar

public JToolBar getToolbar()

getCurrentRoom

public RoomTree getCurrentRoom()

getNewRoom

public JTextField getNewRoom()

addExtendedNewRoomHandler

public void addExtendedNewRoomHandler(ActionListener l)

removeExtendedNewRoomHandler

public void removeExtendedNewRoomHandler(ActionListener l)

setRoomControlsVisible

public void setRoomControlsVisible(boolean visible)

getRoomTree

public RoomTree getRoomTree()