com.sun.java.help.impl.JHSecondaryViewer Maven / Gradle / Ivy
/*
* @(#)JHSecondaryViewer.java 1.25 06/10/30
*
* Copyright (c) 2006 Sun Microsystems, Inc. All Rights Reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Sun designates this
* particular file as subject to the "Classpath" exception as provided
* by Sun in the LICENSE file that accompanied this code.
*
* This code 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
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
* CA 95054 USA or visit www.sun.com if you need additional information or
* have any questions.
*/
package com.sun.java.help.impl;
import java.awt.Component;
import java.awt.Container;
import java.awt.Rectangle;
import java.awt.Point;
import java.awt.Color;
import java.awt.FontMetrics;
import java.awt.Font;
import javax.swing.Icon;
import javax.swing.ImageIcon;
import javax.swing.JButton;
import javax.swing.LookAndFeel;
import javax.swing.SwingUtilities;
import javax.swing.UIManager;
import javax.swing.plaf.basic.BasicButtonUI;
import javax.swing.border.EmptyBorder;
import javax.swing.text.View;
import javax.swing.text.Element;
import javax.swing.text.AttributeSet;
import javax.swing.text.StyleConstants;
import javax.swing.text.Document;
import javax.swing.text.SimpleAttributeSet;
import javax.swing.text.html.HTMLDocument;
import javax.swing.text.html.StyleSheet;
import javax.help.*;
import javax.help.Map.ID;
import java.awt.event.*;
import java.awt.Dimension;
import java.awt.Insets;
import java.net.*;
import java.util.Hashtable;
import java.beans.PropertyChangeEvent;
import java.util.Enumeration;
import java.awt.Cursor;
/**
* This class is a secondary viewer to be included in HTML content within
* JHContentViewer. The ViewerType can either be a SecondaryWindow or a Popup.
* Activation is done be either a Button or a mouse enabled Label. Both Button
* and Label support Text, Icon, or Text and Icon.
*
* To use this class within HTML content use the <object> tag. Below is an
* example usage:
*
* <object CLASSID="java:com.sun.java.help.impl.JHSecondaryViewer">
* <param name="content" value="secondary_contents.html">
* <param name="viewerActivator" value="javax.help.LinkLabel">
* <param name="viewerStyle" value="javax.help.Popup">
* <param name="viewerSize" value="300,400">
* <param name="text" value="Click here">
* <param name="textFontFamily" value="SansSerif">
* <param name="textFontSize" value="x-large">
* <param name="textFontWeight" value="plain">
* <param name="textFontStyle" value="italic">
* <param name="textColor" value="red">
* </object>
*
* Valid parameters are:
*
* - content - a valid url, can be relative to the current viewer
* @see setContent
*
- id - a valid id from the current HelpSet
* @see setId
*
- viewerName - the name of the SecondaryWindow to display the content in
* @see setViewerName
*
- viewerActivator - the activator type for the viewer.
* Either "javax.help.LinkButton" or "javax.help.LinkLabel"
* @see setViewerActivator
*
- viewerStyle - the style of the viewer. Either "SecondaryWindow" or "Popup"
* @see setViewerStyle
*
- viewerLocation - the x,y coordinates applied to a secondary window.
* @see setViewerLocation
*
- viewerSize - the width, height applied to a viewer.
* @see setViewerSize
*
- iconByName - the url or id of a icon to be displayed in the activator.
* The url is relative to the base address of the document
* @see setIconByName
*
- text - the text of the activator
* @see setText
*
- textFontFamily - the font family of the activator text
* @see setTextFontFamily
*
- textFontSize - the size of the activator text font. Size is specified
* in a css termonolgy. See the setTextFontSize for acceptable syntax
* @see setTextFontSize
*
- textFontWeight - the activator text font weight
* @see setTextFontWeight
*
- textFontStyle - the activator text font style
* @see setTextFontStyle
*
- textColor - the activator text color
* @see setTextColor
*
* @see JHSecondaryWindowBeanInfo
*
* @author Roger D. Brinkley
* @version 1.25 10/30/06
*/
public class JHSecondaryViewer extends JButton implements ActionListener, ViewAwareComponent {
private View myView;
private HelpSet hs;
private SimpleAttributeSet textAttribs;
private URL base;
private HTMLDocument doc;
static public String POPUP = "javax.help.Popup";
static public String SECONDARY_WINDOW = "javax.help.SecondaryWindow";
static public String LINK_BUTTON = "javax.help.LinkButton";
static public String LINK_LABEL = "javax.help.LinkLabel";
private final static String buttonPropertyPrefix = "Button" + ".";
private final static String editorPropertyPrefix = "EditorPane" + ".";
private final static Cursor handCursor =
Cursor.getPredefinedCursor(Cursor.HAND_CURSOR);
static private Component container;
private Cursor origCursor;
/**
* Create a secondaryviewer. By default the viewer creates a button with
* the text of ">"
*/
public JHSecondaryViewer() {
super();
setText(">");
setMargin(new Insets(0,0,0,0));
createLinkButton();
addActionListener(this);
origCursor = getCursor();
addMouseListener(new MouseListener() {
public void mouseClicked(MouseEvent e) {
}
public void mouseEntered(MouseEvent e) {
setCursor(handCursor);
}
public void mouseExited(MouseEvent e) {
setCursor(origCursor);
}
public void mousePressed(MouseEvent e) {
}
public void mouseReleased(MouseEvent e) {
}
});
}
/**
* Sets data optained from the View
*/
public void setViewData(View v) {
myView = v;
doc = (HTMLDocument) myView.getDocument();
base = doc.getBase();
// Set the current font information in the local text attributes
Font font = getFont();
textAttribs = new SimpleAttributeSet();
textAttribs.removeAttribute(StyleConstants.FontSize);
textAttribs.removeAttribute(StyleConstants.Bold);
textAttribs.removeAttribute(StyleConstants.Italic);
textAttribs.addAttribute(StyleConstants.FontFamily,
font.getName());
textAttribs.addAttribute(StyleConstants.FontSize,
new Integer(font.getSize()));
textAttribs.addAttribute(StyleConstants.Bold,
new Boolean(font.isBold()));
textAttribs.addAttribute(StyleConstants.Italic,
new Boolean(font.isItalic()));
// Loop through and find the JHelpContentViewer
Component c = container = (Component) myView.getContainer();
while (c != null) {
if (c instanceof JHelpContentViewer) {
break;
}
c = c.getParent();
}
// Get the helpset if there was JHelpContentViewer
if (c !=null) {
TextHelpModel thm = ((JHelpContentViewer)c).getModel();
if (thm != null) {
hs = thm.getHelpSet();
}
}
}
/**
* properties
*/
private int viewerHeight = 0;
private int viewerWidth = 0;
private int viewerX = 0;
private int viewerY = 0;
private String viewerName = "";
private int viewerActivator = 0;
private int viewerStyle = 0;
private Icon viewerIcon;
private String content = "";
private Map.ID ident;
/**
* Set the content for the secondary viewer
* @param content a valid URL
*/
public void setContent(String content) {
debug ("setContent");
this.content = content;
ident = null;
}
/**
* Returns the content of the secondary viewer
*/
public String getContent() {
// return the URL of the ident if set
if (ident != null) {
Map map = hs.getCombinedMap();
try {
URL url = map.getURLFromID(ident);
return (url.toExternalForm());
} catch (Exception ex) {
}
}
// just return the content even if ""
return content;
}
/**
* Set the ID for content in the secondary viewer
* @param content a valid URL
*/
public void setId(String id) {
debug ("setID");
ident = Map.ID.create(id, hs);
content = "";
}
/**
* Returns the ID of the secondary viewer
*/
public String getId() {
return ident.id;
}
/**
* Sets the viewer name to display the content in.
* Viewer is only valid for ViewerStyle "SecondaryWindow"
*/
public void setViewerName(String name) {
debug("setViewerName");
viewerName = name;
}
/**
* Returns the viewer name
*/
public String getViewerName() {
return viewerName;
}
/**
* Sets the viewer activator.
* Valid activators are
*
* - javax.help.LinkButton
*
- javax.help.LinkLabel
*
* The new activatory type will be used the next time a view is displayed.
*/
public void setViewerActivator(String activator) {
debug ("setViewerActivator");
if (activator.compareTo(LINK_BUTTON) == 0 &&
viewerActivator != 0) {
viewerActivator = 0;
createLinkButton();
} else if (activator.compareTo(LINK_LABEL) == 0 &&
viewerActivator != 1) {
viewerActivator = 1;
createLinkLabel();
}
}
/**
* Returns the viewer activator
*/
public String getViewerActivator() {
switch (viewerActivator) {
case 0:
return LINK_BUTTON;
case 1:
return LINK_LABEL;
}
return "unknownStyle";
}
/**
* Creates a link button. This is just a JButton with default settings.
*/
private void createLinkButton() {
LookAndFeel.installBorder(this, buttonPropertyPrefix + "border");
setBorderPainted(true);
setFocusPainted(true);
setAlignmentY(Container.CENTER_ALIGNMENT);
setContentAreaFilled(true);
setBackground(UIManager.getColor(buttonPropertyPrefix + "background"));
if (textAttribs != null &&
textAttribs.isDefined(StyleConstants.Foreground)) {
setForeground((Color)textAttribs.getAttribute(StyleConstants.Foreground));
} else {
setForeground(UIManager.getColor(buttonPropertyPrefix + "foreground"));
}
invalidate();
}
/**
* Creates a link label. A link label is a form of a JButton but without a
* button like appearance.
*/
private void createLinkLabel() {
setBorder(new EmptyBorder(1,1,1,1));
setBorderPainted(false);
setFocusPainted(false);
setAlignmentY(getPreferredLabelAlignment());
setContentAreaFilled(false);
setBackground(UIManager.getColor(editorPropertyPrefix + "background"));
if (textAttribs != null &&
textAttribs.isDefined(StyleConstants.Foreground)) {
setForeground((Color)textAttribs.getAttribute(StyleConstants.Foreground));
} else {
setForeground(Color.blue);
}
invalidate();
}
/**
* Determine the alignment offset so the text is aligned with other views
* correctly.
*/
private float getPreferredLabelAlignment() {
Icon icon = (Icon)getIcon();
String text = getText();
Font font = getFont();
FontMetrics fm = getToolkit().getFontMetrics(font);
Rectangle iconR = new Rectangle();
Rectangle textR = new Rectangle();
Rectangle viewR = new Rectangle(Short.MAX_VALUE, Short.MAX_VALUE);
SwingUtilities.layoutCompoundLabel(
this, fm, text, icon,
getVerticalAlignment(), getHorizontalAlignment(),
getVerticalTextPosition(), getHorizontalTextPosition(),
viewR, iconR, textR,
(text == null ? 0 : ((BasicButtonUI)ui).getDefaultTextIconGap(this))
);
/* The preferred size of the button is the size of
* the text and icon rectangles plus the buttons insets.
*/
Rectangle r = iconR.union(textR);
Insets insets = getInsets();
r.height += insets.top + insets.bottom;
/* Ensure that the height of the button is odd,
* to allow for the focus line.
*/
if(r.height % 2 == 0) {
r.height += 1;
}
float offAmt = fm.getMaxAscent() + insets.top;
return offAmt/(float)r.height;
}
/**
* Sets the viewer style. There are two valid viewer styles:
*
* - javax.help.SecondaryWindow
*
- javax.help.Popup
*
*
* Viewer style is updated the next time the viewer is made visible
* @param style a valid ViewerStyle
*/
public void setViewerStyle(String style) {
debug ("setViewerStyle");
if (style.compareTo(SECONDARY_WINDOW) == 0) {
viewerStyle = 0;
} else if (style.compareTo(POPUP) == 0) {
viewerStyle = 1;
}
}
/**
* Returns the current ViewerStyle
*/
public String getViewerStyle() {
switch (viewerStyle) {
case 0:
return SECONDARY_WINDOW;
case 1:
return POPUP;
}
return "unknownStyle";
}
/**
* Sets the viewer's location to display the content in.
* Location is relative to the screen or a modal dialog box
* The String must be in the form of "x,y". If no viewer location
* is established the default is 0,0 for secondary windows. Location
* is ignored for popups.
* @see getViewerLocation
*/
public void setViewerLocation(String location) {
debug("setViewerLocation");
int comma = location.indexOf(",");
if (comma != -1) {
String x = location.substring(0,comma).trim();
String y = location.substring(comma+1).trim();
if (x != null && y != null) {
viewerX = Integer.parseInt(x);
viewerY = Integer.parseInt(y);
}
}
}
/**
* Returns the viewer Location. Location is relative to the screen or
* a modal dialog box. The form of the location is "x,y".
* The default location is 0,0.
* @see setViewerLocation
*/
public String getViewerLocation() {
String retval = Integer.toString(viewerX) + "," +
Integer.toString(viewerY);
// try to return the acutal viewer locations if it exists
switch (viewerStyle) {
case 0:
SecondaryWindow sw =
SecondaryWindow.getPresentation(viewerName);
if (sw != null) {
Point p = sw.getLocation();
if (p != null) {
retval = Integer.toString(p.x) + "," +
Integer.toString(p.y);
}
}
break;
case 1:
// ignored in popups
break;
}
return retval;
}
/**
* Sets the viewer's size to display the content in.
* The String must be in the form of "width,heigt".
* If no size is set the default is 200,200.
* @see getViewerSize
*/
public void setViewerSize(String size) {
debug ("setViewerSize");
int comma = size.indexOf(",");
if (comma != -1) {
String width = size.substring(0,comma).trim();
String height = size.substring(comma+1).trim();
if (width != null && height != null) {
viewerWidth = Integer.parseInt(width);
viewerHeight = Integer.parseInt(height);
}
}
}
/**
* Returns the viewer's Size.
* The form of the size is "width,height".
* @see setViewerSize
*/
public String getViewerSize() {
String retval = "";
if (viewerWidth != 0) {
retval = Integer.toString(viewerWidth) + "," +
Integer.toString(viewerHeight);
}
// try to return the acutal viewer locations if it exists
switch (viewerStyle) {
case 0:
SecondaryWindow sw =
SecondaryWindow.getPresentation(viewerName);
if (sw != null) {
Dimension size = sw.getSize();
if (size != null) {
retval = Integer.toString(size.width) + "," +
Integer.toString(size.height);
}
}
break;
case 1:
// nothing for popups
break;
}
return retval;
}
/**
* Sets the icon in the activator by url or id. The url is relative to the
* base address of the document.
* @see getIcon
*/
public void setIconByName(String name) {
debug ("setIconByName");
ImageIcon ig = null;
URL url=null;
// try to get it from the base address
try {
url = new URL (base, name);
} catch (java.net.MalformedURLException ex1) {
return;
}
// Valid URLs try the Icon
ig = new ImageIcon(url);
if (ig != null) {
setIcon(ig);
// if the text is the default text then make it blank
String text = getText();
if (text.compareTo(">") == 0) {
setText("");
}
}
}
/**
* Sets the icon in the activator by id.
* @see getIcon
*/
public void setIconByID(String name) {
debug ("setIconByID");
ImageIcon ig = null;
URL url=null;
Map map = hs.getCombinedMap();
try {
url = map.getURLFromID(ID.create(name, hs));
} catch (java.net.MalformedURLException e2) {
return;
}
// Valid URLs try the Icon
ig = new ImageIcon(url);
if (ig != null) {
setIcon(ig);
// if the text is the default text then make it blank
String text = getText();
if (text.compareTo(">") == 0) {
setText("");
}
}
}
/**
* Sets the text Font family for the activator text.
* For JDK 1.1 this must a family name of Dialog, DialogInput, Monospaced,
* Serif, SansSerif, or Symbol.
*/
public void setTextFontFamily(String family) {
textAttribs.removeAttribute(StyleConstants.FontFamily);
textAttribs.addAttribute(StyleConstants.FontFamily, family);
setFont(getAttributeSetFont(textAttribs));
Font font = getFont();
}
/**
* Returns the text Font family name of the activator text
*/
public String getTextFontFamily() {
return StyleConstants.getFontFamily(textAttribs);
}
/**
* Sets the text size for the activator text.
* The String size is a valid Cascading Style Sheet value for
* text size. Acceptable values are as follows:
*
* - xx-small
*
- x-small
*
- small
*
- medium
*
- large
*
- x-large
*
- xx-large
*
- bigger - increase the current base font size by 1
*
- smaller - decrease the current base font size by 1
*
- xxpt - set the font size to a specific pt value of "xx"
*
- +x - increase the current base font size by a value of "x"
*
- -x - decrease the current base font size by a value of "x"
*
- x - set the font size to the point size associated with
* the index "x"
*
*/
public void setTextFontSize(String size) {
int newsize, tmp;
StyleSheet css = doc.getStyleSheet();
try {
if (size.equals("xx-small")) {
newsize = (int)css.getPointSize(0);
} else if (size.equals("x-small")) {
newsize = (int)css.getPointSize(1);
} else if (size.equals("small")) {
newsize = (int)css.getPointSize(2);
} else if (size.equals("medium")) {
newsize = (int)css.getPointSize(3);
} else if (size.equals("large")) {
newsize = (int)css.getPointSize(4);
} else if (size.equals("x-large")) {
newsize = (int)css.getPointSize(5);
} else if (size.equals("xx-large")) {
newsize = (int)css.getPointSize(6);
} else if (size.equals("bigger")) {
newsize = (int)css.getPointSize("+1");
} else if (size.equals("smaller")) {
newsize = (int)css.getPointSize("-1");
} else if (size.endsWith("pt")) {
String sz = size.substring(0, size.length() - 2);
newsize = Integer.parseInt(sz);
} else {
newsize = (int) css.getPointSize(size);
}
} catch (NumberFormatException nfe) {
return;
}
if (newsize == 0) {
return;
}
textAttribs.removeAttribute(StyleConstants.FontSize);
textAttribs.addAttribute(StyleConstants.FontSize,
new Integer(newsize));
setFont(getAttributeSetFont(textAttribs));
Font font = getFont();
}
/**
* Returns the text Font family name of the activator text
*/
public String getTextFontSize() {
return Integer.toString(StyleConstants.getFontSize(textAttribs));
}
/**
* Sets the text Font Weigth for the activator text.
* Valid weights are
*
* - plain
*
- bold
*
*/
public void setTextFontWeight(String weight) {
boolean isBold=false;
if (weight.compareTo("bold") == 0) {
isBold = true;
} else {
isBold = false;
}
textAttribs.removeAttribute(StyleConstants.Bold);
textAttribs.addAttribute(StyleConstants.Bold, new Boolean(isBold));
setFont(getAttributeSetFont(textAttribs));
Font font = getFont();
}
/**
* Returns the text Font weight of the activator text
*/
public String getTextFontWeight() {
if (StyleConstants.isBold(textAttribs)) {
return "bold";
}
return "plain";
}
/**
* Sets the text Font Style for the activator text.
* Valid font styles are
*
* - plain
*
- italic
*
*/
public void setTextFontStyle(String style) {
boolean isItalic=false;
if (style.compareTo("italic") == 0) {
isItalic = true;
} else {
isItalic = false;
}
textAttribs.removeAttribute(StyleConstants.Italic);
textAttribs.addAttribute(StyleConstants.Italic, new Boolean(isItalic));
setFont(getAttributeSetFont(textAttribs));
Font font = getFont();
}
/**
* Returns the text Font style of the activator text
*/
public String getTextFontStyle() {
if (StyleConstants.isItalic(textAttribs)) {
return "italic";
}
return "plain";
}
/**
* Sets the text Color for the activator text.
* The following is a list of supported Color names
*
* - black
*
- blue
*
- cyan
*
- darkGray
*
- gray
*
- green
*
- lightGray
*
- magenta
*
- orange
*
- pink
*
- red
*
- white
*
- yellow
*
*/
public void setTextColor(String name) {
Color color=null;
if (name.compareTo("black") == 0) {
color = Color.black;
} else if (name.compareTo("blue") == 0) {
color = Color.blue;
} else if (name.compareTo("cyan") == 0) {
color = Color.cyan;
} else if (name.compareTo("darkGray") == 0) {
color = Color.darkGray;
} else if (name.compareTo("gray") == 0) {
color = Color.gray;
} else if (name.compareTo("green") == 0) {
color = Color.green;
} else if (name.compareTo("lightGray") == 0) {
color = Color.lightGray;
} else if (name.compareTo("magenta") == 0) {
color = Color.magenta;
} else if (name.compareTo("orange") == 0) {
color = Color.orange;
} else if (name.compareTo("pink") == 0) {
color = Color.pink;
} else if (name.compareTo("red") == 0) {
color = Color.red;
} else if (name.compareTo("white") == 0) {
color = Color.white;
} else if (name.compareTo("yellow") == 0) {
color = Color.yellow;
}
if (color == null) {
return;
}
textAttribs.removeAttribute(StyleConstants.Foreground);
textAttribs.addAttribute(StyleConstants.Foreground, color);
setForeground(color);
}
/**
* Returns the text Color of the activator text
*/
public String getTextColor() {
Color color = getForeground();
return color.toString();
}
/**
* Gets the font from an attribute set. This is
* implemented to try and fetch a cached font
* for the given AttributeSet, and if that fails
* the font features are resolved and the
* font is fetched from the low-level font cache.
* Font's are cached in the StyleSheet of a document
*
* @param attr the attribute set
* @return the font
*/
private Font getAttributeSetFont(AttributeSet attr) {
// PENDING(prinz) add cache behavior
int style = Font.PLAIN;
if (StyleConstants.isBold(attr)) {
style |= Font.BOLD;
}
if (StyleConstants.isItalic(attr)) {
style |= Font.ITALIC;
}
String family = StyleConstants.getFontFamily(attr);
int size = StyleConstants.getFontSize(attr);
/**
* if either superscript or subscript is
* is set, we need to reduce the font size
* by 2.
*/
if (StyleConstants.isSuperscript(attr) ||
StyleConstants.isSubscript(attr)) {
size -= 2;
}
// fonts are cached in the StyleSheet so use that
return doc.getStyleSheet().getFont(family, style, size);
}
/**
* Displays the viewer according to the viewerType
*/
public void actionPerformed(ActionEvent e) {
debug ("actionPerformed");
// System.err.println("clicked on me...");
switch (viewerStyle) {
case 0:
if (hs != null) {
SecondaryWindow sw = (SecondaryWindow)
SecondaryWindow.getPresentation(hs, viewerName);
// set the topic to be displayed
if (ident != null) {
debug ("ident=" + ident);
try {
sw.setCurrentID(ident);
} catch (Exception ex) {
debug ("error setting CurrentID");
// do nothing
}
} else if (content != null) {
debug ("content=" + content);
try {
URL url = new URL(base, content);
sw.setCurrentURL(url);
} catch (Exception ex) {
debug ("error setting URL");
}
}
// set the location if defined
if (viewerX != -1) {
sw.setLocation(new Point(viewerX, viewerY));
}
// set the size if desired
if (viewerWidth != 0) {
sw.setSize(new Dimension(viewerWidth, viewerHeight));
}
// make sure the secondary window is displayed
sw.setDisplayed(true);
}
break;
case 1:
if (hs != null) {
Popup popup = (Popup) Popup.getPresentation(hs, viewerName);
// set the topic to be displayed
if (ident != null) {
debug ("ident=" + ident);
try {
popup.setCurrentID(ident);
} catch (Exception ex) {
debug ("error setting CurrentID");
// do nothing
}
} else if (content != null) {
debug ("content=" + content);
try {
URL url = new URL(base, content);
popup.setCurrentURL(url);
} catch (Exception ex) {
debug ("error setting URL");
}
}
// set the size if desired
if (viewerWidth != 0) {
popup.setSize(new Dimension(viewerWidth, viewerHeight));
}
popup.setInvoker(this);
// make sure the popup is displayed
popup.setDisplayed(true);
}
break;
default:
System.out.println ("Unknown viewerStyle");
}
}
/**
* For printf debugging.
*/
private final static boolean debug = false;
private static void debug(String str) {
if (debug) {
System.out.println("JHSecondaryWindow: " + str);
}
}
}