Add classes that can track when a controller root is shown or

attached

build.gradle

@@ -21,20 +21,20 @@ apply plugin: 'io.spring.dependency-management'
 // source: https://github.com/mendhak/Gradle-Travis-Colored-Output/blob/master/ColoredOutput.gradle
 tasks.withType(Test).configureEach {
 
-  String ANSI_BOLD_WHITE = "\u001B[0;1m";
-  String ANSI_RESET = "\u001B[0m";
-  String ANSI_BLACK = "\u001B[30m";
-  String ANSI_RED = "\u001B[31m";
-  String ANSI_GREEN = "\u001B[32m";
-  String ANSI_YELLOW = "\u001B[33m";
-  String ANSI_BLUE = "\u001B[34m";
-  String ANSI_PURPLE = "\u001B[35m";
-  String ANSI_CYAN = "\u001B[36m";
-  String ANSI_WHITE = "\u001B[37m";
-  String CHECK_MARK = "\u2713";
-  String NEUTRAL_FACE = "\u0CA0_\u0CA0";
-  String X_MARK = "\u274C";
-  String indent = '\t';
+  String ANSI_BOLD_WHITE = "\u001B[0;1m"
+  String ANSI_RESET = "\u001B[0m"
+  String ANSI_BLACK = "\u001B[30m"
+  String ANSI_RED = "\u001B[31m"
+  String ANSI_GREEN = "\u001B[32m"
+  String ANSI_YELLOW = "\u001B[33m"
+  String ANSI_BLUE = "\u001B[34m"
+  String ANSI_PURPLE = "\u001B[35m"
+  String ANSI_CYAN = "\u001B[36m"
+  String ANSI_WHITE = "\u001B[37m"
+  String CHECK_MARK = "\u2713"
+  String NEUTRAL_FACE = "\u0CA0_\u0CA0"
+  String X_MARK = "\u274C"
+  String indent = '\t'
 
   def outputCache = new HashMap<TestDescriptor, List<String>>()
 
@@ -71,21 +71,21 @@ tasks.withType(Test).configureEach {
 
       switch (result.resultType) {
         case TestResult.ResultType.SUCCESS:
-          summaryStyle = ANSI_GREEN;
-          break;
+          summaryStyle = ANSI_GREEN
+          break
         case TestResult.ResultType.FAILURE:
-          summaryStyle = ANSI_RED;
-          break;
+          summaryStyle = ANSI_RED
+          break
       }
 
-      out.println("--------------------------------------------------------------------------");
+      out.println("--------------------------------------------------------------------------")
       out.println("Results: " + summaryStyle + " ${result.resultType} " + ANSI_RESET
               + " (${result.testCount} tests, "
               + ANSI_GREEN + " ${result.successfulTestCount} passed " + ANSI_RESET
               + ", " + failStyle + " ${result.failedTestCount} failed " + ANSI_RESET
               + ", " + skipStyle + " ${result.skippedTestCount} skipped " + ANSI_RESET
-              + ")");
-      out.println("--------------------------------------------------------------------------");
+              + ")")
+      out.println("--------------------------------------------------------------------------")
     }
   }
 }

src/main/java/com/faforever/client/achievements/AchievementItemController.java

@@ -1,7 +1,7 @@
 package com.faforever.client.achievements;
 
-import com.faforever.client.fx.Controller;
 import com.faforever.client.fx.FxApplicationThreadExecutor;
+import com.faforever.client.fx.NodeController;
 import com.faforever.client.i18n.I18n;
 import com.faforever.client.util.Assert;
 import com.faforever.commons.api.dto.AchievementDefinition;
@@ -24,7 +24,7 @@
 @Scope(ConfigurableBeanFactory.SCOPE_PROTOTYPE)
 @RequiredArgsConstructor
 // TODO this class should not use API objects
-public class AchievementItemController implements Controller<Node> {
+public class AchievementItemController extends NodeController<Node> {
 
   private final I18n i18n;
   private final AchievementService achievementService;
@@ -39,11 +39,13 @@ public class AchievementItemController implements Controller<Node> {
   public ImageView imageView;
   private AchievementDefinition achievementDefinition;
 
-  public void initialize() {
+  @Override
+  protected void onInitialize() {
     progressBar.managedProperty().bind(progressBar.visibleProperty());
     progressLabel.managedProperty().bind(progressLabel.visibleProperty());
   }
 
+  @Override
   public Node getRoot() {
     return achievementItemRoot;
   }

src/main/java/com/faforever/client/api/IceServer.java

@@ -1,4 +1,3 @@
 package com.faforever.client.api;
 
-public record IceServer(String id, String region) {
-}
+public record IceServer(String id, String region) {}

src/main/java/com/faforever/client/chat/AbstractChatTabController.java

@@ -5,11 +5,11 @@
 import com.faforever.client.domain.AvatarBean;
 import com.faforever.client.domain.PlayerBean;
 import com.faforever.client.exception.AssetLoadException;
-import com.faforever.client.fx.Controller;
 import com.faforever.client.fx.FxApplicationThreadExecutor;
 import com.faforever.client.fx.JavaFxUtil;
 import com.faforever.client.fx.SimpleChangeListener;
 import com.faforever.client.fx.SimpleInvalidationListener;
+import com.faforever.client.fx.TabController;
 import com.faforever.client.fx.WebViewConfigurer;
 import com.faforever.client.i18n.I18n;
 import com.faforever.client.main.event.NavigateEvent;
@@ -96,7 +96,7 @@
  */
 @Slf4j
 @RequiredArgsConstructor
-public abstract class AbstractChatTabController implements Controller<Tab> {
+public abstract class AbstractChatTabController extends TabController {
 
   static final String CSS_CLASS_CHAT_ONLY = "chat_only";
   private static final String MESSAGE_CONTAINER_ID = "chat-container";
@@ -167,7 +167,8 @@ public abstract class AbstractChatTabController implements Controller<Tab> {
   @VisibleForTesting
   Pattern mentionPattern;
 
-  public void initialize() {
+  @Override
+  protected void onInitialize() {
     BooleanExpression tabPaneShowing = BooleanExpression.booleanExpression(getRoot().tabPaneProperty()
                                                                                     .flatMap(
                                                                                         uiService::createShowingProperty));
@@ -263,6 +264,7 @@ protected void setUnread(boolean unread) {
     }
   }
 
+  @Override
   public abstract Tab getRoot();
 
   protected void incrementUnreadMessagesCount() {

src/main/java/com/faforever/client/chat/ChannelTabController.java

@@ -112,8 +112,8 @@ public ChannelTabController(WebViewConfigurer webViewConfigurer, LoginService lo
   }
 
   @Override
-  public void initialize() {
-    super.initialize();
+  protected void onInitialize() {
+    super.onInitialize();
     JavaFxUtil.bindManagedToVisible(topicPane, chatUserList, changeTopicTextButton, topicTextField,
                                     cancelChangesTopicTextButton, topicText, topicCharactersLimitLabel,
                                     chatMessageSearchContainer);

src/main/java/com/faforever/client/chat/ChatCategoryItemController.java

@@ -1,7 +1,7 @@
 package com.faforever.client.chat;
 
-import com.faforever.client.fx.Controller;
 import com.faforever.client.fx.JavaFxUtil;
+import com.faforever.client.fx.NodeController;
 import com.faforever.client.fx.contextmenu.ChatCategoryColorPickerCustomMenuItemController;
 import com.faforever.client.fx.contextmenu.ContextMenuBuilder;
 import com.faforever.client.i18n.I18n;
@@ -31,7 +31,7 @@
 @Component
 @Scope(ConfigurableBeanFactory.SCOPE_PROTOTYPE)
 @RequiredArgsConstructor
-public class ChatCategoryItemController implements Controller<Node> {
+public class ChatCategoryItemController extends NodeController<Node> {
 
   private final I18n i18n;
   private final UiService uiService;
@@ -49,7 +49,7 @@ public class ChatCategoryItemController implements Controller<Node> {
   public Label userCounterLabel;
 
   @Override
-  public void initialize() {
+  protected void onInitialize() {
     bindProperties();
   }
 

src/main/java/com/faforever/client/chat/ChatController.java

@@ -1,9 +1,9 @@
 package com.faforever.client.chat;
 
 import com.faforever.client.exception.ProgrammingError;
-import com.faforever.client.fx.AbstractViewController;
 import com.faforever.client.fx.FxApplicationThreadExecutor;
 import com.faforever.client.fx.JavaFxUtil;
+import com.faforever.client.fx.NodeController;
 import com.faforever.client.main.event.NavigateEvent;
 import com.faforever.client.net.ConnectionState;
 import com.faforever.client.theme.UiService;
@@ -32,7 +32,7 @@
 @Component
 @Scope(ConfigurableBeanFactory.SCOPE_PROTOTYPE)
 @RequiredArgsConstructor
-public class ChatController extends AbstractViewController<AnchorPane> {
+public class ChatController extends NodeController<AnchorPane> {
 
   private final ChatService chatService;
   private final UiService uiService;
@@ -60,8 +60,8 @@ public class ChatController extends AbstractViewController<AnchorPane> {
   public TextField channelNameTextField;
 
   @Override
-  public void initialize() {
-    super.initialize();
+  protected void onInitialize() {
+    super.onInitialize();
 
     BooleanExpression showing = uiService.createShowingProperty(getRoot());
 
@@ -159,6 +159,7 @@ private void onConnectionStateChange(ConnectionState newValue) {
     }
   }
 
+  @Override
   public AnchorPane getRoot() {
     return chatRoot;
   }
@@ -174,7 +175,7 @@ public void onJoinChannelButtonClicked() {
   }
 
   @Override
-  protected void onDisplay(NavigateEvent navigateEvent) {
+  protected void onNavigate(NavigateEvent navigateEvent) {
     if (tabPane.getTabs().size() > 1) {
       Tab tab = tabPane.getSelectionModel().getSelectedItem();
       Optional.ofNullable(channelToChatTabController.get((ChatChannel) tab.getUserData()))

src/main/java/com/faforever/client/chat/ChatUserItemController.java

@@ -4,9 +4,9 @@
 import com.faforever.client.domain.AvatarBean;
 import com.faforever.client.domain.GameBean;
 import com.faforever.client.domain.PlayerBean;
-import com.faforever.client.fx.Controller;
 import com.faforever.client.fx.ImageViewHelper;
 import com.faforever.client.fx.JavaFxUtil;
+import com.faforever.client.fx.NodeController;
 import com.faforever.client.fx.contextmenu.AddEditPlayerNoteMenuItem;
 import com.faforever.client.fx.contextmenu.AddFoeMenuItem;
 import com.faforever.client.fx.contextmenu.AddFriendMenuItem;
@@ -65,7 +65,7 @@
 @Scope(ConfigurableBeanFactory.SCOPE_PROTOTYPE)
 @Slf4j
 @RequiredArgsConstructor
-public class ChatUserItemController implements Controller<Node> {
+public class ChatUserItemController extends NodeController<Node> {
 
   private final I18n i18n;
   private final UiService uiService;
@@ -95,7 +95,8 @@ public class ChatUserItemController implements Controller<Node> {
   private Tooltip countryTooltip;
   private Tooltip noteTooltip;
 
-  public void initialize() {
+  @Override
+  protected void onInitialize() {
     initializeTooltips();
     bindProperties();
   }
@@ -189,6 +190,7 @@ public void onItemClicked(MouseEvent mouseEvent) {
     }
   }
 
+  @Override
   public Pane getRoot() {
     return root;
   }

src/main/java/com/faforever/client/chat/ChatUserListController.java

@@ -1,9 +1,9 @@
 package com.faforever.client.chat;
 
 import com.faforever.client.filter.ChatUserFilterController;
-import com.faforever.client.fx.Controller;
 import com.faforever.client.fx.FxApplicationThreadExecutor;
 import com.faforever.client.fx.JavaFxUtil;
+import com.faforever.client.fx.NodeController;
 import com.faforever.client.game.GameTooltipController;
 import com.faforever.client.i18n.I18n;
 import com.faforever.client.preferences.ChatPrefs;
@@ -61,7 +61,7 @@
 @Component
 @Scope(ConfigurableBeanFactory.SCOPE_PROTOTYPE)
 @RequiredArgsConstructor
-public class ChatUserListController implements Controller<VBox> {
+public class ChatUserListController extends NodeController<VBox> {
 
   private static final Comparator<ChatListItem> CHAT_LIST_ITEM_COMPARATOR = Comparator.comparing(ChatListItem::category)
       .thenComparing(ChatListItem::user, Comparator.nullsFirst(Comparator.comparing(ChatChannelUser::getUsername)));
@@ -101,7 +101,7 @@ public class ChatUserListController implements Controller<VBox> {
   private ChatUserFilterController chatUserFilterController;
 
   @Override
-  public void initialize() {
+  protected void onInitialize() {
     ObservableValue<Boolean> showing = uiService.createShowingProperty(getRoot());
 
     hiddenCategories.bind(Bindings.valueAt(chatPrefs.getChannelNameToHiddenCategories(), chatChannel.map(ChatChannel::getName))

src/main/java/com/faforever/client/chat/KittehChatService.java

@@ -522,6 +522,7 @@ public void destroy() {
     close();
   }
 
+  @Override
   public void close() {
     if (client != null) {
       client.shutdown();

src/main/java/com/faforever/client/chat/MatchmakingChatController.java

@@ -74,8 +74,8 @@ public MatchmakingChatController(LoginService loginService,
   }
 
   @Override
-  public void initialize() {
-    super.initialize();
+  protected void onInitialize() {
+    super.onInitialize();
 
     ObservableValue<Boolean> showing = getRoot().selectedProperty()
         .and(BooleanExpression.booleanExpression(getRoot().tabPaneProperty()

src/main/java/com/faforever/client/chat/PrivateChatTabController.java

@@ -78,8 +78,9 @@ public PrivateChatTabController(LoginService loginService,
     this.audioService = audioService;
   }
 
-  public void initialize() {
-    super.initialize();
+  @Override
+  protected void onInitialize() {
+    super.onInitialize();
 
     ObservableValue<Boolean> showing = getRoot().selectedProperty()
         .and(BooleanExpression.booleanExpression(getRoot().tabPaneProperty()

src/main/java/com/faforever/client/chat/TrustEveryoneFactory.java

@@ -25,12 +25,15 @@ protected void engineInit(ManagerFactoryParameters spec) {
       @Override
       protected TrustManager[] engineGetTrustManagers() {
         return new TrustManager[]{new X509TrustManager() {
+          @Override
           public void checkClientTrusted(X509Certificate[] chain, String authType) {
           }
 
+          @Override
           public void checkServerTrusted(X509Certificate[] chain, String authType) {
           }
 
+          @Override
           public X509Certificate[] getAcceptedIssuers() {
             return null;
           }

src/main/java/com/faforever/client/chat/UserListCustomizationController.java

@@ -1,6 +1,6 @@
 package com.faforever.client.chat;
 
-import com.faforever.client.fx.Controller;
+import com.faforever.client.fx.NodeController;
 import com.faforever.client.preferences.ChatPrefs;
 import javafx.scene.control.CheckBox;
 import javafx.scene.layout.VBox;
@@ -12,7 +12,7 @@
 @Component
 @Scope(ConfigurableBeanFactory.SCOPE_PROTOTYPE)
 @RequiredArgsConstructor
-public class UserListCustomizationController implements Controller<VBox> {
+public class UserListCustomizationController extends NodeController<VBox> {
 
   private final ChatPrefs chatPrefs;
 
@@ -21,7 +21,7 @@ public class UserListCustomizationController implements Controller<VBox> {
   public CheckBox showMapPreviewCheckBox;
 
   @Override
-  public void initialize() {
+  protected void onInitialize() {
     showMapNameCheckBox.selectedProperty().bindBidirectional(chatPrefs.showMapNameProperty());
     showMapPreviewCheckBox.selectedProperty().bindBidirectional(chatPrefs.showMapPreviewProperty());
   }

src/main/java/com/faforever/client/chat/emoticons/EmoticonController.java

@@ -1,6 +1,6 @@
 package com.faforever.client.chat.emoticons;
 
-import com.faforever.client.fx.Controller;
+import com.faforever.client.fx.NodeController;
 import javafx.scene.control.Tooltip;
 import javafx.scene.image.ImageView;
 import javafx.scene.layout.AnchorPane;
@@ -19,7 +19,7 @@
 @Component
 @Scope(ConfigurableBeanFactory.SCOPE_PROTOTYPE)
 @RequiredArgsConstructor
-public class EmoticonController implements Controller<AnchorPane> {
+public class EmoticonController extends NodeController<AnchorPane> {
 
   private final Font shortcodesFont = new Font(14d);