You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

GlobalWindow.java 5.6KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145
  1. /*
  2. * Copyright (c) 2006-2015 DMDirc Developers
  3. *
  4. * Permission is hereby granted, free of charge, to any person obtaining a copy
  5. * of this software and associated documentation files (the "Software"), to deal
  6. * in the Software without restriction, including without limitation the rights
  7. * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  8. * copies of the Software, and to permit persons to whom the Software is
  9. * furnished to do so, subject to the following conditions:
  10. *
  11. * The above copyright notice and this permission notice shall be included in
  12. * all copies or substantial portions of the Software.
  13. *
  14. * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  15. * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  16. * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  17. * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  18. * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  19. * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  20. * SOFTWARE.
  21. */
  22. package com.dmdirc;
  23. import com.dmdirc.ClientModule.GlobalConfig;
  24. import com.dmdirc.commandparser.CommandType;
  25. import com.dmdirc.commandparser.parsers.GlobalCommandParser;
  26. import com.dmdirc.events.CommandErrorEvent;
  27. import com.dmdirc.interfaces.Connection;
  28. import com.dmdirc.interfaces.EventBus;
  29. import com.dmdirc.interfaces.config.AggregateConfigProvider;
  30. import com.dmdirc.interfaces.config.ConfigChangeListener;
  31. import com.dmdirc.ui.WindowManager;
  32. import com.dmdirc.ui.core.components.WindowComponent;
  33. import com.dmdirc.ui.input.TabCompleterFactory;
  34. import com.dmdirc.ui.messages.BackBufferFactory;
  35. import java.util.Arrays;
  36. import java.util.Optional;
  37. import javax.inject.Inject;
  38. import javax.inject.Provider;
  39. import javax.inject.Singleton;
  40. /**
  41. * A window which can be used to execute global commands.
  42. */
  43. @Singleton
  44. public class GlobalWindow extends FrameContainer {
  45. /**
  46. * Creates a new instance of GlobalWindow.
  47. */
  48. @Inject
  49. public GlobalWindow(@GlobalConfig final AggregateConfigProvider config,
  50. final GlobalCommandParser parser, final TabCompleterFactory tabCompleterFactory,
  51. final EventBus eventBus, final BackBufferFactory backBufferFactory) {
  52. super("icon", "Global", "(Global)", config, backBufferFactory, eventBus,
  53. Arrays.asList(WindowComponent.TEXTAREA.getIdentifier(),
  54. WindowComponent.INPUTFIELD.getIdentifier()));
  55. initBackBuffer();
  56. setInputModel(new DefaultInputModel(
  57. this::sendLine,
  58. parser,
  59. tabCompleterFactory.getTabCompleter(config, CommandType.TYPE_GLOBAL),
  60. this::getMaxLineLength
  61. ));
  62. }
  63. @Override
  64. public Optional<Connection> getConnection() {
  65. return Optional.empty();
  66. }
  67. private void sendLine(final String line) {
  68. getEventBus().publishAsync(
  69. new CommandErrorEvent(this, "You may only enter commands in the global window."));
  70. }
  71. private int getMaxLineLength() {
  72. return -1;
  73. }
  74. /** Handles the state of the global window. */
  75. @Singleton
  76. public static class GlobalWindowManager implements ConfigChangeListener {
  77. /** Provider to use to obtain global window instances. */
  78. private final Provider<GlobalWindow> globalWindowProvider;
  79. /** The global configuration to read settings from. */
  80. private final AggregateConfigProvider globalConfig;
  81. /** The provider to use to retrieve a window manager. */
  82. private final Provider<WindowManager> windowManagerProvider;
  83. /**
  84. * Creates a new instance of {@link GlobalWindowManager}.
  85. *
  86. * @param globalWindowProvider The provider to use to obtain global windows.
  87. * @param globalConfig Configuration provider to read settings from.
  88. * @param windowManagerProvider The provider to use to retrieve a window manager.
  89. */
  90. @Inject
  91. public GlobalWindowManager(final Provider<GlobalWindow> globalWindowProvider,
  92. @GlobalConfig final AggregateConfigProvider globalConfig,
  93. final Provider<WindowManager> windowManagerProvider) {
  94. this.globalWindowProvider = globalWindowProvider;
  95. this.globalConfig = globalConfig;
  96. this.windowManagerProvider = windowManagerProvider;
  97. }
  98. @Override
  99. public void configChanged(final String domain, final String key) {
  100. updateWindowState();
  101. }
  102. /**
  103. * Initialises the global window if it's enabled in the config.
  104. */
  105. public void init() {
  106. globalConfig.addChangeListener("general", "showglobalwindow", this);
  107. updateWindowState();
  108. }
  109. /**
  110. * Updates the state of the global window in line with the general.showglobalwindow config
  111. * setting.
  112. */
  113. protected void updateWindowState() {
  114. final WindowManager windowManager = windowManagerProvider.get();
  115. final GlobalWindow globalWindow = globalWindowProvider.get();
  116. final boolean globalWindowExists =
  117. windowManager.getRootWindows().contains(globalWindow);
  118. if (globalConfig.getOptionBool("general", "showglobalwindow")) {
  119. if (!globalWindowExists) {
  120. windowManager.addWindow(globalWindow);
  121. }
  122. } else {
  123. if (globalWindowExists) {
  124. globalWindow.close();
  125. }
  126. }
  127. }
  128. }
  129. }