org.relayirc.swingui
Class ChatOptions

java.lang.Object
  |
  +--org.relayirc.swingui.ChatOptions

All Implemented Interfaces:

java.io.Serializable

public class ChatOptions

extends java.lang.Object

implements java.io.Serializable

User's option settings such as nick name, font and colors as well as favorite servers, channels and users.
Properties supported by getProperty and setProperty.

• gui.lookAndFeel
• gui.statusBar.enabled
• gui.channel.font.name
• gui.channel.font.style
• gui.channel.font.size
• gui.channel.color.messages
• gui.channel.color.actions
• gui.channel.color.joins
• gui.channel.color.parts
• gui.channel.color.ops
• gui.channel.color.kicks
• gui.channel.color.bans
• gui.channel.color.nicks

Coming soon...

gui.console.dock

gui.console.show

gui.favoritesTree.dock

gui.favoritesTree.show

gui.pythonWindow.show

Version:

$Revision: 1.4.2.4 $

The contents of this file are subject to the Mozilla Public License Version 1.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.mozilla.org/MPL/

Original Code: Relay IRC Chat Engine
Initial Developer: David M. Johnson
Contributor(s): No contributors to this file
Copyright (C) 1997-2000 by David M. Johnson
All Rights Reserved.

Author:

David M. Johnson.

See Also:

Serialized Form

Inner Class Summary

class	ChatOptions.ActionList
class	ChatOptions.ChannelList
class	ChatOptions.ListenerList
class	ChatOptions.ObjectList Base class for internal collections.
class	ChatOptions.ServerList
class	ChatOptions.UserList

Constructor Summary

ChatOptions()

Method Summary

void	addPropertyChangeListener(java.beans.PropertyChangeListener listener)
ChatOptions.ServerList	getAllServers() Get all servers, favorites have isFavorite = true.
Server	getCurrentServer() Get the current server.
User	getCurrentUser() Get the current user.
ChatOptions.ActionList	getCustomChannelActions() Get custom channel actions.
ChatOptions.ListenerList	getCustomChannelListeners() Get custom channel listeners.
ChatOptions.ActionList	getCustomMenuActions() Get custom menu actions.
ChatOptions.ActionList	getCustomServerActions() Get custom server actions.
ChatOptions.ListenerList	getCustomServerListeners() Get custom server listeners.
ChatOptions.ActionList	getCustomUserActions() Get custom user actions.
ChatOptions.ChannelList	getFavoriteChannels() Get favorite channels.
ChatOptions.UserList	getFavoriteUsers() Get favorite users.
java.lang.String	getProperty(java.lang.String name) Get a named string property, or empty string if propety is undefined.
void	initNewOptions() Initialize options with default values.
boolean	isFresh() Determine if user has edited options before.
void	removePropertyChangeListener(java.beans.PropertyChangeListener listener)
void	setCurrentServer(Server s) Set the current server.
void	setCurrentUser(User u) Set the current user.
void	setFresh(boolean fresh) Set to false if user has edited options.
void	setProperty(java.lang.String name, java.lang.String value) Set a named string property, fires property change event.

Methods inherited from class java.lang.Object

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

Constructor Detail

ChatOptions

public ChatOptions()

Method Detail

getCurrentUser

public User getCurrentUser()

Get the current user.

setCurrentUser

public void setCurrentUser(User u)

Set the current user.

getCurrentServer

public Server getCurrentServer()

Get the current server.

setCurrentServer

public void setCurrentServer(Server s)

Set the current server.

getFavoriteUsers

public ChatOptions.UserList getFavoriteUsers()

Get favorite users.

getFavoriteChannels

public ChatOptions.ChannelList getFavoriteChannels()

Get favorite channels.

getAllServers

public ChatOptions.ServerList getAllServers()

Get all servers, favorites have isFavorite = true.

getCustomUserActions

public ChatOptions.ActionList getCustomUserActions()

Get custom user actions.

getCustomChannelActions

public ChatOptions.ActionList getCustomChannelActions()

Get custom channel actions.

getCustomServerActions

public ChatOptions.ActionList getCustomServerActions()

Get custom server actions.

getCustomMenuActions

public ChatOptions.ActionList getCustomMenuActions()

Get custom menu actions.

getCustomServerListeners

public ChatOptions.ListenerList getCustomServerListeners()

Get custom server listeners.

getCustomChannelListeners

public ChatOptions.ListenerList getCustomChannelListeners()

Get custom channel listeners.

setProperty

public void setProperty(java.lang.String name,
                        java.lang.String value)

Set a named string property, fires property change event.

getProperty

public java.lang.String getProperty(java.lang.String name)

Get a named string property, or empty string if propety is undefined.

isFresh

public boolean isFresh()

Determine if user has edited options before.

setFresh

public void setFresh(boolean fresh)

Set to false if user has edited options.

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)

removePropertyChangeListener

public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)

initNewOptions

public void initNewOptions()

Initialize options with default values.