Fix bobbylight#219: Add 'armed' fold icon background property color to theme

Author: bobbylight

src/main/java/org/fife/ui/rsyntaxtextarea/Theme.java

@@ -103,6 +103,7 @@ public class Theme {
 	public int lineNumberFontSize;
 	public Color foldIndicatorFG;
 	public Color foldBG;
+	public Color armedFoldBG;
 
 
 	/**
@@ -166,6 +167,7 @@ public Theme(RSyntaxTextArea textArea) {
 			lineNumberFontSize = gutter.getLineNumberFont().getSize();
 			foldIndicatorFG = gutter.getFoldIndicatorForeground();
 			foldBG = gutter.getFoldBackground();
+			armedFoldBG = gutter.getArmedFoldBackground();
 		}
 
 	}
@@ -219,6 +221,8 @@ public void apply(RSyntaxTextArea textArea) {
 			gutter.setLineNumberFont(font);
 			gutter.setFoldIndicatorForeground(foldIndicatorFG);
 			gutter.setFoldBackground(foldBG);
+			System.out.println("Setting armed fold bg to: " + armedFoldBG + " (foldbg == " + foldBG + ")");
+			gutter.setArmedFoldBackground(armedFoldBG);
 		}
 
 	}
@@ -458,6 +462,7 @@ public void save(OutputStream out) throws IOException {
 			elem = doc.createElement("foldIndicator");
 			elem.setAttribute("fg", colorToString(foldIndicatorFG));
 			elem.setAttribute("iconBg", colorToString(foldBG));
+			elem.setAttribute("iconArmedBg", colorToString(armedFoldBG));
 			root.appendChild(elem);
 
 			elem = doc.createElement("iconRowHeader");
@@ -694,6 +699,8 @@ else if ("foldIndicator".equals(qName)) {
 				theme.foldIndicatorFG = stringToColor(color);
 				color = attrs.getValue("iconBg");
 				theme.foldBG = stringToColor(color);
+				color = attrs.getValue("iconArmedBg");
+				theme.armedFoldBG = stringToColor(color);
 			}
 
 			else if ("gutterBorder".equals(qName)) {

src/main/java/org/fife/ui/rtextarea/FoldIndicator.java

@@ -69,6 +69,12 @@ public class FoldIndicator extends AbstractGutterComponent {
 	 */
 	private Color foldIconBackground;
 
+	/**
+	 * The color to use for armed fold icon backgrounds, if the default icons
+	 * are used.  This may be {@code null}.
+	 */
+	private Color foldIconArmedBackground;
+
 	/**
 	 * The icon used for collapsed folds.
 	 */
@@ -79,6 +85,18 @@ public class FoldIndicator extends AbstractGutterComponent {
 	 */
 	private Icon expandedFoldIcon;
 
+	/**
+	 * Used while painting; global flag to denote whether the mouse is over
+	 * a fold indicator.
+	 */
+	private boolean mouseOverFoldIcon;
+
+	/**
+	 * Used while painting; global flag to denote whether the
+	 * currently-being-painted fold should be rendered as armed.
+	 */
+	private boolean paintFoldArmed;
+
 	/**
 	 * Whether tool tips are displayed showing the contents of collapsed
 	 * fold regions.
@@ -138,6 +156,7 @@ public JToolTip createToolTip() {
 	private Fold findOpenFoldClosestTo(Point p) {
 
 		Fold fold = null;
+		mouseOverFoldIcon = false;
 
 		RSyntaxTextArea rsta = (RSyntaxTextArea)textArea;
 		if (rsta.isCodeFoldingEnabled()) { // Should always be true
@@ -147,7 +166,11 @@ private Fold findOpenFoldClosestTo(Point p) {
 					int line = rsta.getLineOfOffset(offs);
 					FoldManager fm = rsta.getFoldManager();
 					fold = fm.getFoldForLine(line);
-					if (fold==null) {
+					if (fold != null) {
+						// The mouse is directly over the fold indicator
+						mouseOverFoldIcon = true;
+					}
+					else {
 						fold = fm.getDeepestOpenFoldContaining(offs);
 					}
 				} catch (BadLocationException ble) {
@@ -161,12 +184,27 @@ private Fold findOpenFoldClosestTo(Point p) {
 	}
 
 
+	/**
+	 * Returns the color to use for the "background" of armed fold icons.  This
+	 * is ignored if custom icons are used.
+	 *
+	 * @return The background color.  If this is {@code null}, there is no
+	 *         special color for armed fold icons.
+	 * @see #setFoldIconArmedBackground(Color)
+	 * @see #getFoldIconBackground()
+	 */
+	public Color getFoldIconArmedBackground() {
+		return foldIconArmedBackground;
+	}
+
+
 	/**
 	 * Returns the color to use for the "background" of fold icons.  This
-	 * is be ignored if custom icons are used.
+	 * is ignored if custom icons are used.
 	 *
 	 * @return The background color.
 	 * @see #setFoldIconBackground(Color)
+	 * @see #getFoldIconArmedBackground()
 	 */
 	public Color getFoldIconBackground() {
 		return foldIconBackground;
@@ -379,11 +417,16 @@ protected void paintComponent(Graphics g) {
 			}
 			Fold fold = fm.getFoldForLine(line);
 			if (fold!=null) {
-				if (fold==foldWithOutlineShowing && !fold.isCollapsed()) {
-					g.setColor(getForeground());
-					int w2 = width/2;
-					g.drawLine(w2,y+cellHeight/2, w2,y+cellHeight);
-					paintingOutlineLine = true;
+				if (fold==foldWithOutlineShowing) {
+					if (!fold.isCollapsed()) {
+						g.setColor(getForeground());
+						int w2 = width/2;
+						g.drawLine(w2,y+cellHeight/2, w2,y+cellHeight);
+						paintingOutlineLine = true;
+					}
+					if (mouseOverFoldIcon) {
+						paintFoldArmed = true;
+					}
 				}
 				if (fold.isCollapsed()) {
 					collapsedFoldIcon.paintIcon(this, g, x, y);
@@ -404,6 +447,7 @@ protected void paintComponent(Graphics g) {
 				else {
 					expandedFoldIcon.paintIcon(this, g, x, y);
 				}
+				paintFoldArmed = false;
 			}
 			line++;
 			y += cellHeight;
@@ -498,11 +542,16 @@ private void paintComponentWrapped(Graphics g) {
 			}
 			Fold fold = fm.getFoldForLine(line);
 			if (fold!=null) {
-				if (fold==foldWithOutlineShowing && !fold.isCollapsed()) {
-					g.setColor(getForeground());
-					int w2 = width/2;
-					g.drawLine(w2,y+cellHeight/2, w2,y+curLineH);
-					paintingOutlineLine = true;
+				if (fold==foldWithOutlineShowing) {
+					if (!fold.isCollapsed()) {
+						g.setColor(getForeground());
+						int w2 = width/2;
+						g.drawLine(w2,y+cellHeight/2, w2,y+curLineH);
+						paintingOutlineLine = true;
+					}
+					if (mouseOverFoldIcon) {
+						paintFoldArmed = true;
+					}
 				}
 				if (fold.isCollapsed()) {
 					collapsedFoldIcon.paintIcon(this, g, x, y);
@@ -515,6 +564,7 @@ private void paintComponentWrapped(Graphics g) {
 					y += curLineH;
 					line++;
 				}
+				paintFoldArmed = false;
 			}
 			else {
 				y += curLineH;
@@ -543,12 +593,27 @@ private int rowAtPoint(Point p) {
 	}
 
 
+	/**
+	 * Sets the color to use for the "background" of armed fold icons.  This
+	 * will be ignored if custom icons are used.
+	 *
+	 * @param bg The new background color.  If {@code null} is passed in,
+	 *        there will be no special color for armed fold icons.
+	 * @see #getFoldIconArmedBackground()
+	 * @see #setFoldIconBackground(Color)
+	 */
+	public void setFoldIconArmedBackground(Color bg) {
+		foldIconArmedBackground = bg;
+	}
+
+
 	/**
 	 * Sets the color to use for the "background" of fold icons.  This will
 	 * be ignored if custom icons are used.
 	 *
-	 * @param bg The new background color.
+	 * @param bg The new background color.  This should not be {@code null}.
 	 * @see #getFoldIconBackground()
+	 * @see #setFoldIconArmedBackground(Color)
 	 */
 	public void setFoldIconBackground(Color bg) {
 		foldIconBackground = bg;
@@ -631,7 +696,11 @@ public int getIconWidth() {
 
 		@Override
 		public void paintIcon(Component c, Graphics g, int x, int y) {
-			g.setColor(foldIconBackground);
+			Color bg = foldIconBackground;
+			if (paintFoldArmed && foldIconArmedBackground != null) {
+				bg = foldIconArmedBackground;
+			}
+			g.setColor(bg);
 			g.fillRect(x,y, 8,8);
 			g.setColor(getForeground());
 			g.drawRect(x,y, 8,8);
@@ -658,12 +727,6 @@ private class Listener extends MouseInputAdapter
 		@Override
 		public void mouseClicked(MouseEvent e) {
 
-//			// TODO: Implement code folding with word wrap enabled
-//			if (textArea.getLineWrap()) {
-//				UIManager.getLookAndFeel().provideErrorFeedback(textArea);
-//				return;
-//			}
-
 			Point p = e.getPoint();
 			int line = rowAtPoint(p);
 
@@ -683,18 +746,23 @@ public void mouseClicked(MouseEvent e) {
 		public void mouseExited(MouseEvent e) {
 			if (foldWithOutlineShowing!=null) {
 				foldWithOutlineShowing = null;
+				mouseOverFoldIcon = false;
 				repaint();
 			}
 		}
 
 		@Override
 		public void mouseMoved(MouseEvent e) {
+			boolean oldMouseOverFoldIcon = mouseOverFoldIcon;
 			Fold newSelectedFold = findOpenFoldClosestTo(e.getPoint());
 			if (newSelectedFold!=foldWithOutlineShowing &&
 					newSelectedFold!=null && !newSelectedFold.isOnSingleLine()) {
 				foldWithOutlineShowing = newSelectedFold;
 				repaint();
 			}
+			else if (mouseOverFoldIcon != oldMouseOverFoldIcon) {
+				repaint();
+			}
 		}
 
 		@Override

src/main/java/org/fife/ui/rtextarea/Gutter.java

@@ -265,6 +265,19 @@ public Color getActiveLineRangeColor() {
 	}
 
 
+	/**
+	 * Returns the background color used by the (default) fold icons when they
+	 * are armed.
+	 *
+	 * @return The background color.
+	 * @see #setArmedFoldBackground(Color)
+	 * @see #getFoldBackground()
+	 */
+	public Color getArmedFoldBackground() {
+		return foldIndicator.getFoldIconArmedBackground();
+	}
+
+
 	/**
 	 * Returns the icon to use for bookmarks.
 	 *
@@ -506,6 +519,20 @@ private void setActiveLineRange(int startLine, int endLine) {
 	}
 
 
+	/**
+	 * Sets the background color used by the (default) fold icons when they
+	 * are armed.
+	 *
+	 * @param bg The new background color.  If this is {@code null}, then
+	 *        armed fold icons will not render with a special color.
+	 * @see #getArmedFoldBackground()
+	 * @see #setFoldBackground(Color)
+	 */
+	public void setArmedFoldBackground(Color bg) {
+		foldIndicator.setFoldIconArmedBackground(bg);
+	}
+
+
 	/**
 	 * Sets the icon to use for bookmarks.
 	 *
@@ -609,6 +636,7 @@ public void setFoldIndicatorEnabled(boolean enabled) {
 	 *
 	 * @param bg The new background color.
 	 * @see #getFoldBackground()
+	 * @see #setArmedFoldBackground(Color)
 	 */
 	public void setFoldBackground(Color bg) {
 		if (bg==null) {

src/main/resources/org/fife/ui/rsyntaxtextarea/themes/dark.xml

@@ -29,7 +29,7 @@
    <!-- Gutter styling. -->
    <gutterBorder color="81969A"/>
    <lineNumbers fg="81969A"/>
-   <foldIndicator fg="6A8088" iconBg="2f383c"/>
+   <foldIndicator fg="6A8088" iconBg="2f383c" iconArmedBg="3f484c"/>
    <iconRowHeader activeLineRange="3399ff"/>
 
    <!-- Syntax tokens. -->

src/main/resources/org/fife/ui/rsyntaxtextarea/themes/monokai.xml

@@ -24,7 +24,7 @@
     <!-- Gutter styling. -->
     <gutterBorder color="81969A"/>
     <lineNumbers fg="81969A"/>
-    <foldIndicator fg="6A8088" iconBg="2f383c"/>
+    <foldIndicator fg="6A8088" iconBg="2f383c" iconArmedBg="3f484c"/>
     <iconRowHeader activeLineRange="878787"/>
 
     <!-- Syntax tokens. -->

src/main/resources/org/fife/ui/rsyntaxtextarea/themes/theme.dtd

@@ -63,8 +63,9 @@
       fontFamily CDATA #IMPLIED
       fontSize   CDATA #IMPLIED>
 <!ATTLIST foldIndicator
-      fg         CDATA #REQUIRED
-      iconBg     CDATA #REQUIRED>
+      fg          CDATA #REQUIRED
+      iconBg      CDATA #REQUIRED
+      iconArmedBg CDATA #IMPLIED>
 <!ATTLIST iconRowHeader
       activeLineRange CDATA #REQUIRED
       inheritsGutterBG (true|false) "false">