Add some comments to the manual

master
skylarmt 10 years ago
parent 6e76dcbb04
commit b733d695f5

@ -15,7 +15,6 @@
<SyntheticProperty name="formSizePolicy" type="int" value="1"/> <SyntheticProperty name="formSizePolicy" type="int" value="1"/>
</SyntheticProperties> </SyntheticProperties>
<Events> <Events>
<EventHandler event="componentResized" listener="java.awt.event.ComponentListener" parameters="java.awt.event.ComponentEvent" handler="formComponentResized"/>
<EventHandler event="componentShown" listener="java.awt.event.ComponentListener" parameters="java.awt.event.ComponentEvent" handler="formComponentShown"/> <EventHandler event="componentShown" listener="java.awt.event.ComponentListener" parameters="java.awt.event.ComponentEvent" handler="formComponentShown"/>
</Events> </Events>
<AuxValues> <AuxValues>

@ -40,8 +40,9 @@ import javax.swing.text.html.StyleSheet;
*/ */
public class Help extends javax.swing.JInternalFrame { public class Help extends javax.swing.JInternalFrame {
// True if this is a manual, false if about window /*
private boolean topicOnLoad = true; Some styling stuff.
*/
private final HTMLEditorKit kit; private final HTMLEditorKit kit;
private final StyleSheet styleSheet; private final StyleSheet styleSheet;
private final StyleSheet dark = new StyleSheet(); private final StyleSheet dark = new StyleSheet();
@ -58,6 +59,9 @@ public class Help extends javax.swing.JInternalFrame {
loadTheme(); loadTheme();
} }
/**
* Load the styles for the main box.
*/
private void loadStyleSheets() { private void loadStyleSheets() {
dark.addRule("body { background-color: #293134; }"); dark.addRule("body { background-color: #293134; }");
dark.addRule("h1 { color: #ffffff; }"); dark.addRule("h1 { color: #ffffff; }");
@ -69,6 +73,9 @@ public class Help extends javax.swing.JInternalFrame {
light.addRule("p { color: #000000; }"); light.addRule("p { color: #000000; }");
} }
/**
* (Re)load the theme for this window.
*/
private void loadTheme() { private void loadTheme() {
if (PrefStorage.getSetting("theme").equals("dark")) { if (PrefStorage.getSetting("theme").equals("dark")) {
topicList.setBackground(new Color(41, 49, 52)); topicList.setBackground(new Color(41, 49, 52));
@ -86,6 +93,10 @@ public class Help extends javax.swing.JInternalFrame {
loadTopic(topicList.getSelectedValue().toString().toLowerCase()); loadTopic(topicList.getSelectedValue().toString().toLowerCase());
} }
/**
* Load a help topic from the help package.
* @param name The name of the help file, without the ".html".
*/
public void loadTopic(String name) { public void loadTopic(String name) {
if (name.equals("welcome")) { if (name.equals("welcome")) {
String text = "<html><head><title>About SyMAT</title></head>" String text = "<html><head><title>About SyMAT</title></head>"
@ -158,9 +169,6 @@ public class Help extends javax.swing.JInternalFrame {
setTitle("Manual"); setTitle("Manual");
setFrameIcon(new javax.swing.ImageIcon(getClass().getResource("/net/apocalypselabs/symat/icons/help.png"))); // NOI18N setFrameIcon(new javax.swing.ImageIcon(getClass().getResource("/net/apocalypselabs/symat/icons/help.png"))); // NOI18N
addComponentListener(new java.awt.event.ComponentAdapter() { addComponentListener(new java.awt.event.ComponentAdapter() {
public void componentResized(java.awt.event.ComponentEvent evt) {
formComponentResized(evt);
}
public void componentShown(java.awt.event.ComponentEvent evt) { public void componentShown(java.awt.event.ComponentEvent evt) {
formComponentShown(evt); formComponentShown(evt);
} }
@ -225,22 +233,13 @@ public class Help extends javax.swing.JInternalFrame {
private void formComponentShown(java.awt.event.ComponentEvent evt) {//GEN-FIRST:event_formComponentShown private void formComponentShown(java.awt.event.ComponentEvent evt) {//GEN-FIRST:event_formComponentShown
topicList.setSelectedIndex(0); topicList.setSelectedIndex(0);
if (topicOnLoad) { loadTopic("welcome");
loadTopic("welcome");
}
}//GEN-LAST:event_formComponentShown }//GEN-LAST:event_formComponentShown
private void topicListMouseClicked(java.awt.event.MouseEvent evt) {//GEN-FIRST:event_topicListMouseClicked private void topicListMouseClicked(java.awt.event.MouseEvent evt) {//GEN-FIRST:event_topicListMouseClicked
loadTheme(); loadTheme();
}//GEN-LAST:event_topicListMouseClicked }//GEN-LAST:event_topicListMouseClicked
private void formComponentResized(java.awt.event.ComponentEvent evt) {//GEN-FIRST:event_formComponentResized
if (!topicOnLoad) {
jSplitPane1.setDividerLocation(0.0);
jSplitPane1.setResizeWeight(0.0);
}
}//GEN-LAST:event_formComponentResized
private void topicBrowserMouseClicked(java.awt.event.MouseEvent evt) {//GEN-FIRST:event_topicBrowserMouseClicked private void topicBrowserMouseClicked(java.awt.event.MouseEvent evt) {//GEN-FIRST:event_topicBrowserMouseClicked
loadTheme(); loadTheme();
}//GEN-LAST:event_topicBrowserMouseClicked }//GEN-LAST:event_topicBrowserMouseClicked

Loading…
Cancel
Save