Files
ts3java/ts3-client/swing/src/main/java/com/ts3client/ui/MainMenuBar.java
T
erikbrockoandClaude Opus 5.5 ee1a83e981 Add shortcuts for Disconnect, Ban List and Options
Ctrl+D disconnects from the current server, Ctrl+Shift+B opens the ban
list (only where it may be viewed) and Alt+P the options.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-04 00:11:15 +00:00

381 lines
15 KiB
Java

package com.ts3client.ui;
import com.ts3client.config.Bookmark;
import com.ts3client.config.Bookmarks;
import javax.swing.ImageIcon;
import javax.swing.JCheckBoxMenuItem;
import javax.swing.JMenu;
import javax.swing.JMenuBar;
import javax.swing.JMenuItem;
import javax.swing.JPopupMenu;
import javax.swing.KeyStroke;
import javax.swing.MenuSelectionManager;
import javax.swing.SwingUtilities;
import javax.swing.event.MenuEvent;
import javax.swing.event.MenuListener;
import java.awt.Component;
import java.awt.event.MouseAdapter;
import java.awt.event.MouseEvent;
/**
* The main window's menu bar: Connections, Bookmarks, Self, Permissions, Tools and Help.
* Talks to {@link MainFrame} only through {@link Listener}; the away/commander
* item states are pushed in by {@link #refresh}, mirroring how {@link MainToolbar}
* is kept in sync.
*/
final class MainMenuBar extends JMenuBar {
interface Listener {
void onConnect();
void onDisconnect();
void onCloseTab();
void onQuit();
/** Moves the microphone to the tab on screen. */
void onActivate();
void onToggleMic();
void onToggleSpeaker();
/** The plain toggle carries no message; "Set away status…" is where messages are chosen. */
void onAwayToggle(boolean away);
void onAwayStatus();
/** The away button's drop-down, which the "Set Away" submenu mirrors. */
JPopupMenu buildAwayMenu();
void onCommanderToggle(boolean commander);
void onChangeNickname();
/** Whether our talk power request is pending; asked as the Self menu opens. */
boolean isTalkPowerRequested();
/** Requests talk power, or withdraws a pending request. */
void onRequestTalkPower();
void onSetPhoneticNickname();
/** Whether the current server lets us upload an avatar; asked as the Self menu opens. */
boolean canSetAvatar();
void onSetAvatar();
/** Whether we have an avatar on the current server to delete; asked as the Self menu opens. */
boolean hasAvatar();
void onDeleteAvatar();
void onShowIdentities();
void onShowContacts();
/** Whether the current server lets us read its ban list; asked as the Tools menu opens. */
boolean canViewBanList();
void onShowBanList();
/** Whether the current server lets us list its privilege keys; asked as the Permissions menu opens. */
boolean canListPrivilegeKeys();
void onShowPrivilegeKeys();
void onUsePrivilegeKey();
void onShowSettings();
void onShowAbout();
/** @param newTab open the server in a new tab instead of replacing the current one */
void onConnectBookmark(Bookmark bookmark, boolean newTab);
void onAddCurrentServerBookmark();
void onManageBookmarks();
}
private final Bookmarks bookmarks;
private final Listener listener;
private JMenu bookmarksMenu;
private JMenu awayMenu;
private JMenuItem activateItem;
private JMenuItem muteItem;
private JMenuItem deafItem;
private JCheckBoxMenuItem awayItem;
private JMenuItem awayStatusItem;
private JCheckBoxMenuItem commanderItem;
private JMenuItem talkPowerItem;
private JMenuItem phoneticItem;
private JMenuItem avatarItem;
private JMenuItem deleteAvatarItem;
private JMenuItem banListItem;
private JMenuItem privilegeKeysItem;
private JMenuItem usePrivilegeKeyItem;
MainMenuBar(Bookmarks bookmarks, Listener listener) {
this.bookmarks = bookmarks;
this.listener = listener;
JMenu connections = new JMenu("Connections");
JMenuItem connect = new JMenuItem("Connect…", Icons.of("CONNECT"));
connect.setAccelerator(KeyStroke.getKeyStroke("control S"));
connect.addActionListener(e -> listener.onConnect());
JMenuItem disconnect = new JMenuItem("Disconnect", Icons.of("DISCONNECT"));
disconnect.setAccelerator(KeyStroke.getKeyStroke("control D"));
disconnect.addActionListener(e -> listener.onDisconnect());
JMenuItem closeTab = new JMenuItem("Close tab", Icons.of("CLOSE_BUTTON"));
closeTab.setAccelerator(KeyStroke.getKeyStroke("control W"));
closeTab.addActionListener(e -> listener.onCloseTab());
JMenuItem quit = new JMenuItem("Quit", Icons.of("QUIT"));
quit.setAccelerator(KeyStroke.getKeyStroke("control Q"));
quit.addActionListener(e -> listener.onQuit());
connections.add(connect);
connections.add(disconnect);
connections.add(closeTab);
connections.addSeparator();
connections.add(quit);
bookmarksMenu = new JMenu("Bookmarks");
rebuildBookmarks();
// A server's icon may have finished downloading since the menu was built.
bookmarksMenu.addMenuListener(new MenuListener() {
@Override
public void menuSelected(MenuEvent e) {
rebuildBookmarks();
}
@Override
public void menuDeselected(MenuEvent e) {
}
@Override
public void menuCanceled(MenuEvent e) {
}
});
JMenu self = new JMenu("Self");
awayMenu = new JMenu("Set Away");
awayMenu.setIcon(Icons.of("AWAY"));
awayMenu.addMenuListener(new MenuListener() {
@Override
public void menuSelected(MenuEvent e) {
rebuildAwayMenu();
}
@Override
public void menuDeselected(MenuEvent e) {
}
@Override
public void menuCanceled(MenuEvent e) {
}
});
activateItem = new JMenuItem("Activate Microphone", Icons.of("ACTIVATE_MICROPHONE"));
activateItem.addActionListener(e -> listener.onActivate());
muteItem = new JMenuItem();
muteItem.addActionListener(e -> listener.onToggleMic());
deafItem = new JMenuItem();
deafItem.addActionListener(e -> listener.onToggleSpeaker());
showMuted(false, false);
awayItem = new JCheckBoxMenuItem("Away", Icons.of("AWAY"), false);
awayItem.addActionListener(e -> listener.onAwayToggle(awayItem.isSelected()));
awayStatusItem = new JMenuItem("Set away status…", Icons.of("EDIT"));
awayStatusItem.addActionListener(e -> listener.onAwayStatus());
commanderItem = new JCheckBoxMenuItem("Channel commander", Icons.of("CHANNEL_COMMANDER"), false);
commanderItem.addActionListener(e -> listener.onCommanderToggle(commanderItem.isSelected()));
JMenuItem nick = new JMenuItem("Change nickname…", Icons.of("CHANGE_NICKNAME"));
nick.addActionListener(e -> listener.onChangeNickname());
talkPowerItem = new JMenuItem();
talkPowerItem.addActionListener(e -> listener.onRequestTalkPower());
showTalkPowerRequested(false);
phoneticItem = new JMenuItem("Set Phonetic Nickname…", Icons.of("PHONETICSNICKNAME"));
phoneticItem.addActionListener(e -> listener.onSetPhoneticNickname());
avatarItem = new JMenuItem("Set avatar…", Icons.of("UPLOAD_AVATAR"));
avatarItem.addActionListener(e -> listener.onSetAvatar());
deleteAvatarItem = new JMenuItem("Delete avatar", Icons.of("DELETE_AVATAR"));
deleteAvatarItem.addActionListener(e -> listener.onDeleteAvatar());
self.add(awayMenu);
self.add(activateItem);
self.add(muteItem);
self.add(deafItem);
self.addSeparator();
self.add(commanderItem);
self.addSeparator();
self.add(nick);
self.add(talkPowerItem);
self.add(phoneticItem);
self.add(avatarItem);
self.add(deleteAvatarItem);
self.addMenuListener(new MenuListener() {
@Override
public void menuSelected(MenuEvent e) {
showTalkPowerRequested(listener.isTalkPowerRequested());
avatarItem.setVisible(!avatarItem.isEnabled() || listener.canSetAvatar());
deleteAvatarItem.setVisible(listener.hasAvatar());
}
@Override
public void menuDeselected(MenuEvent e) {
}
@Override
public void menuCanceled(MenuEvent e) {
}
});
JMenu permissions = new JMenu("Permissions");
privilegeKeysItem = new JMenuItem("Privilege Keys", Icons.of("TOKEN"));
privilegeKeysItem.addActionListener(e -> listener.onShowPrivilegeKeys());
usePrivilegeKeyItem = new JMenuItem("Use Privilege Key", Icons.of("TOKEN_USE"));
usePrivilegeKeyItem.addActionListener(e -> listener.onUsePrivilegeKey());
permissions.add(privilegeKeysItem);
permissions.add(usePrivilegeKeyItem);
permissions.addMenuListener(new MenuListener() {
@Override
public void menuSelected(MenuEvent e) {
privilegeKeysItem.setVisible(!privilegeKeysItem.isEnabled() || listener.canListPrivilegeKeys());
}
@Override
public void menuDeselected(MenuEvent e) {
}
@Override
public void menuCanceled(MenuEvent e) {
}
});
JMenu tools = new JMenu("Tools");
JMenuItem identitiesItem = new JMenuItem("Identities…", Icons.of("IDENTITY_MANAGER"));
identitiesItem.setAccelerator(KeyStroke.getKeyStroke("control I"));
identitiesItem.addActionListener(e -> listener.onShowIdentities());
JMenuItem contactsItem = new JMenuItem("Contacts…", Icons.ofAny("CONTACT", "EDIT_FRIEND_FOE_STATUS"));
contactsItem.setAccelerator(KeyStroke.getKeyStroke("control shift O"));
contactsItem.addActionListener(e -> listener.onShowContacts());
banListItem = new JMenuItem("Ban List", Icons.of("BAN_LIST"));
banListItem.setAccelerator(KeyStroke.getKeyStroke("control shift B"));
// The shortcut works while the item is hidden, so it asks for itself.
banListItem.addActionListener(e -> {
if (listener.canViewBanList()) listener.onShowBanList();
});
JMenuItem options = new JMenuItem("Options…", Icons.of("SETTINGS"));
options.setAccelerator(KeyStroke.getKeyStroke("alt P"));
options.addActionListener(e -> listener.onShowSettings());
JPopupMenu.Separator banListSeparator = new JPopupMenu.Separator();
tools.add(identitiesItem);
tools.add(contactsItem);
tools.addSeparator();
tools.add(banListItem);
tools.add(banListSeparator);
tools.add(options);
// Permissions arrive after the connection does, so the item is judged as the menu opens
// rather than on a fixed refresh.
tools.addMenuListener(new MenuListener() {
@Override
public void menuSelected(MenuEvent e) {
boolean shown = banListItem.isEnabled() && listener.canViewBanList();
banListItem.setVisible(shown);
banListSeparator.setVisible(shown);
}
@Override
public void menuDeselected(MenuEvent e) {
}
@Override
public void menuCanceled(MenuEvent e) {
}
});
JMenu help = new JMenu("Help");
JMenuItem about = new JMenuItem("About", Icons.of("ABOUT"));
about.addActionListener(e -> listener.onShowAbout());
help.add(about);
add(connections);
add(bookmarksMenu);
add(self);
add(permissions);
add(tools);
add(help);
}
/** Reflects the current tab's state on the menu items. */
void refresh(boolean connected, boolean anyConnected, boolean micMuted, boolean deafened,
boolean active, boolean away, boolean commander) {
awayMenu.setEnabled(anyConnected);
activateItem.setEnabled(connected && !active);
muteItem.setEnabled(connected);
deafItem.setEnabled(connected);
showMuted(micMuted, deafened);
awayItem.setEnabled(connected);
awayStatusItem.setEnabled(connected);
commanderItem.setEnabled(connected);
talkPowerItem.setEnabled(connected);
phoneticItem.setEnabled(connected);
avatarItem.setEnabled(connected);
deleteAvatarItem.setEnabled(connected);
banListItem.setEnabled(connected);
privilegeKeysItem.setEnabled(connected);
usePrivilegeKeyItem.setEnabled(connected);
awayItem.setSelected(away);
commanderItem.setSelected(commander);
}
private void showTalkPowerRequested(boolean requested) {
talkPowerItem.setText(requested ? "Cancel Talk Power Request" : "Request Talk Power…");
talkPowerItem.setIcon(Icons.of(requested ? "TALK_POWER_CANCEL_REQUEST" : "TALK_POWER_REQUEST"));
}
private void showMuted(boolean micMuted, boolean deafened) {
muteItem.setText(micMuted ? "Unmute Microphone" : "Mute Microphone");
muteItem.setIcon(Icons.of(micMuted ? "CAPTURE" : "INPUT_MUTED"));
deafItem.setText(deafened ? "Unmute Speakers/Headphones" : "Mute Speakers/Headphones");
deafItem.setIcon(Icons.of(deafened ? "PLAYBACK" : "OUTPUT_MUTED"));
}
/** The toolbar button's toggle and status for this server, then its drop-down's global items. */
private void rebuildAwayMenu() {
awayMenu.removeAll();
awayMenu.add(awayItem);
awayMenu.add(awayStatusItem);
awayMenu.addSeparator();
for (Component c : listener.buildAwayMenu().getComponents()) awayMenu.getPopupMenu().add(c);
}
/** Re-lists the saved bookmarks; called after they change (add, remove, manage…). */
void rebuildBookmarks() {
bookmarksMenu.removeAll();
JMenuItem addCurrent = new JMenuItem("Add to Bookmarks…", Icons.of("BOOKMARK_ADD"));
addCurrent.addActionListener(e -> listener.onAddCurrentServerBookmark());
JMenuItem manage = new JMenuItem("Manage Bookmarks…", Icons.of("BOOKMARK_MANAGER"));
manage.setAccelerator(KeyStroke.getKeyStroke("control B"));
manage.addActionListener(e -> listener.onManageBookmarks());
bookmarksMenu.add(addCurrent);
bookmarksMenu.add(manage);
if (!bookmarks.all().isEmpty()) bookmarksMenu.addSeparator();
for (Bookmark b : bookmarks.all()) {
ImageIcon serverIcon = GroupIcons.cached(b.iconId);
JMenuItem item = new JMenuItem(b.displayName(), serverIcon != null ? serverIcon : Icons.of("SERVER_GREEN"));
item.setToolTipText("Connect here (middle-click to open a new tab)");
item.addActionListener(e -> listener.onConnectBookmark(b, false));
item.addMouseListener(new MouseAdapter() {
@Override
public void mousePressed(MouseEvent e) {
if (!SwingUtilities.isMiddleMouseButton(e)) return;
MenuSelectionManager.defaultManager().clearSelectedPath();
listener.onConnectBookmark(b, true);
}
});
bookmarksMenu.add(item);
}
}
}