-
Notifications
You must be signed in to change notification settings - Fork 177
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #6001 from IllianiCBT/immersiveDialog_glossary
Added Glossary Functionality to `MHQDialogImmersive` with Clickable Hyperlink Support
- Loading branch information
Showing
6 changed files
with
280 additions
and
59 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| PRISONER_CAPACITY.title=Prisoner Capacity | ||
| PRISONER_CAPACITY.definition=Prisoner Capacity is a measure of how many prisoners your Security\ | ||
| \ personnel can manage without potential crisis. Generally speaking, each prisoner takes up 1\ | ||
| \ capacity; however, some events may change this.\ | ||
| <p>For additional information on Prisoner Capacity and how to manage it, please see the\ | ||
| \ documentation in...\ | ||
| <br>MekHQ/docs/Stratcon and Against the Bot/Prisoners.pdf</p> | ||
|
|
||
| REPUTATION.title=Reputation | ||
| REPUTATION.definition=Reputation is a measure of how well known your unit is and whether people\ | ||
| \ generally believe you can get the job done. The rules for Reputation can be found in Campaign\ | ||
| \ Operations. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,169 @@ | ||
| /* | ||
| * Copyright (c) 2025 - The MegaMek Team. All Rights Reserved. | ||
| * | ||
| * This file is part of MekHQ. | ||
| * | ||
| * MekHQ is free software: you can redistribute it and/or modify | ||
| * it under the terms of the GNU General Public License as published by | ||
| * the Free Software Foundation, either version 3 of the License, or | ||
| * (at your option) any later version. | ||
| * | ||
| * MekHQ is distributed in the hope that it will be useful, | ||
| * but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| * GNU General Public License for more details. | ||
| * | ||
| * You should have received a copy of the GNU General Public License | ||
| * along with MekHQ. If not, see <http://www.gnu.org/licenses/>. | ||
| */ | ||
| package mekhq.gui.dialog; | ||
|
|
||
| import megamek.client.ui.swing.util.UIUtil; | ||
| import megamek.logging.MMLogger; | ||
| import mekhq.campaign.Campaign; | ||
|
|
||
| import javax.swing.*; | ||
| import javax.swing.event.HyperlinkEvent.EventType; | ||
| import java.awt.*; | ||
| import java.awt.event.WindowAdapter; | ||
| import java.awt.event.WindowEvent; | ||
|
|
||
| import static java.lang.Math.round; | ||
| import static javax.swing.BorderFactory.createEmptyBorder; | ||
| import static megamek.client.ui.swing.util.FlatLafStyleBuilder.setFontScaling; | ||
| import static mekhq.gui.baseComponents.MHQDialogImmersive.handleImmersiveHyperlinkClick; | ||
| import static mekhq.utilities.MHQInternationalization.getFormattedTextAt; | ||
| import static mekhq.utilities.MHQInternationalization.isResourceKeyValid; | ||
|
|
||
| /** | ||
| * The {@code GlossaryDialog} class represents a dialog window for displaying glossary entries. | ||
| * It displays detailed information about a glossary term, including its title and description, | ||
| * in a styled HTML format. | ||
| * | ||
| * <p> | ||
| * This class uses a {@link JEditorPane} to render glossary entry content and supports hyperlink | ||
| * interactions for related glossary entries. If a related term is clicked, a new {@code GlossaryDialog} | ||
| * is opened to show its details. | ||
| * </p> | ||
| */ | ||
| public class GlossaryDialog extends JDialog { | ||
| private static final MMLogger logger = MMLogger.create(GlossaryDialog.class); | ||
|
|
||
| private final JDialog parent; | ||
| private final Campaign campaign; | ||
|
|
||
| private int CENTER_WIDTH = UIUtil.scaleForGUI(400); | ||
| private int CENTER_HEIGHT = UIUtil.scaleForGUI(300); | ||
| private int PADDING = UIUtil.scaleForGUI(10); | ||
|
|
||
| private final String GLOSSARY_BUNDLE = "mekhq.resources.Glossary"; | ||
|
|
||
| /** | ||
| * Creates a new {@code GlossaryDialog} instance to display information about a glossary term. | ||
| * | ||
| * <p> | ||
| * The dialog retrieves the glossary term's title and description using the provided key | ||
| * and displays the content in a styled format. During its construction, the parent dialog | ||
| * is hidden to ensure that only this dialog is visible to the user. | ||
| * </p> | ||
| * | ||
| * @param parent The parent {@link JDialog} that is temporarily hidden while this dialog is displayed. | ||
| * @param campaign The {@link Campaign} object containing resources and glossary entries. | ||
| * @param key The unique identifier for the glossary term to be displayed. | ||
| */ | ||
| public GlossaryDialog(JDialog parent, Campaign campaign, String key) { | ||
| this.parent = parent; | ||
| this.campaign = campaign; | ||
|
|
||
| parent.setVisible(false); | ||
| buildDialog(key); | ||
| } | ||
|
|
||
| /** | ||
| * Builds the Glossary Dialog by setting its title and definition based on the key provided. | ||
| * | ||
| * <p> | ||
| * This method fetches the title and definition strings for the glossary term from the | ||
| * resource bundle. If the title is invalid (i.e., the resource key is not found), | ||
| * it logs an error and terminates the dialog building process. | ||
| * </p> | ||
| * | ||
| * @param key The resource key used to retrieve the glossary term's title and definition. | ||
| */ | ||
| private void buildDialog(String key) { | ||
| String title = getFormattedTextAt(GLOSSARY_BUNDLE, key + ".title"); | ||
| if (!isResourceKeyValid(title)) { | ||
| logger.error("No valid title for {}", key); | ||
| return; | ||
| } | ||
|
|
||
| String description = getFormattedTextAt(GLOSSARY_BUNDLE, key + ".definition"); | ||
| if (!isResourceKeyValid(description)) { | ||
| logger.error("No valid definition for {}", key); | ||
| return; | ||
| } | ||
|
|
||
| setTitle(title); | ||
|
|
||
| // Create a JEditorPane for the message | ||
| JEditorPane editorPane = new JEditorPane(); | ||
| editorPane.setContentType("text/html"); | ||
| editorPane.setEditable(false); | ||
| editorPane.setFocusable(false); | ||
|
|
||
| // Use inline CSS to set font family, size, and other style properties | ||
| String fontStyle = "font-family: Noto Sans;"; | ||
| editorPane.setText(String.format( | ||
| "<div style='width: %s; %s'>" | ||
| + "<h1 style='text-align: center;'>%s</h1>" | ||
| + "%s</div>", | ||
| CENTER_WIDTH, fontStyle, title, description | ||
| )); | ||
| setFontScaling(editorPane, false, 1.1); | ||
|
|
||
| // Add a HyperlinkListener to capture hyperlink clicks | ||
| editorPane.addHyperlinkListener(evt -> { | ||
| if (evt.getEventType() == EventType.ACTIVATED) { | ||
| handleImmersiveHyperlinkClick(parent, campaign, evt.getDescription()); | ||
| } | ||
| }); | ||
|
|
||
| // Wrap the JEditorPane in a JScrollPane | ||
| JScrollPane scrollPane = new JScrollPane(editorPane); | ||
| scrollPane.setMinimumSize(new Dimension(CENTER_WIDTH, scrollPane.getHeight())); | ||
|
|
||
| // Create a JPanel with padding | ||
| JPanel paddedPanel = new JPanel(new BorderLayout()); | ||
| paddedPanel.setBorder(createEmptyBorder(PADDING, PADDING, PADDING, PADDING)); | ||
| paddedPanel.add(scrollPane, BorderLayout.CENTER); | ||
| add(paddedPanel); | ||
|
|
||
| // Assign close action | ||
| setDefaultCloseOperation(DO_NOTHING_ON_CLOSE); | ||
| addWindowListener(new WindowAdapter() { | ||
| @Override | ||
| public void windowClosing(WindowEvent e) { | ||
| onCloseAction(); | ||
| } | ||
| }); | ||
|
|
||
| // Set dialog properties | ||
| setSize((int) round((CENTER_WIDTH + (PADDING * 2)) * 1.1), CENTER_HEIGHT); | ||
| setLocationRelativeTo(null); | ||
| setModal(true); | ||
| setVisible(true); | ||
| } | ||
|
|
||
| /** | ||
| * Handles user interactions when the dialog is closed. | ||
| * | ||
| * <p> | ||
| * This method ensures the parent dialog is made visible again after the glossary | ||
| * dialog is closed. | ||
| * </p> | ||
| */ | ||
| private void onCloseAction() { | ||
| dispose(); | ||
| parent.setVisible(true); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.