javax.help.WindowPresentation Maven / Gradle / Ivy
/*
* @(#) WindowPresentation.java 1.21 - last change made 11/01/04
*
* Copyright (c) 1997 Sun Microsystems, Inc. All Rights Reserved.
*
* This software is the confidential and proprietary information of Sun
* Microsystems, Inc. ("Confidential Information"). You shall not
* disclose such Confidential Information and shall use it only in
* accordance with the terms of the license agreement you entered into
* with Sun.
*
* SUN MAKES NO REPRESENTATIONS OR WARRANTIES ABOUT THE SUITABILITY OF THE
* SOFTWARE, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
* IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
* PURPOSE, OR NON-INFRINGEMENT. SUN SHALL NOT BE LIABLE FOR ANY DAMAGES
* SUFFERED BY LICENSEE AS A RESULT OF USING, MODIFYING OR DISTRIBUTING
* THIS SOFTWARE OR ITS DERIVATIVES.
*/
package javax.help;
import javax.swing.JDialog;
import javax.swing.JFrame;
import javax.swing.SwingUtilities;
import java.awt.Component;
import java.awt.Dialog;
import java.awt.Dimension;
import java.awt.Font;
import java.awt.Frame;
import java.awt.GraphicsConfiguration;
import java.awt.GraphicsDevice;
import java.awt.GraphicsEnvironment;
import java.awt.Image;
import java.awt.MenuComponent;
import java.awt.Point;
import java.awt.Rectangle;
import java.awt.Window;
import java.awt.event.WindowAdapter;
import java.awt.event.WindowEvent;
import java.awt.event.WindowListener;
import java.beans.PropertyChangeEvent;
import java.beans.PropertyChangeListener;
import java.lang.reflect.Method;
import java.net.URL;
import java.util.Enumeration;
import java.util.Locale;
import javax.swing.ImageIcon;
/**
* Window Presentation is an abstract class providing a generic interface for
* the development of Window Presentations. Each implementation of
* Presentation will need to override the static method getPresentation
* according to it's own needs.
*
* WindowPresentation implements several generic methods required in all
* window presentations. Includes the ability to handle modal and non-modal
* activation of the help window.
*
* @author Roger D.Brinkley
* @version 1.21 11/01/04
* @since 2.0
*
* @see javax.help.HelpSet
* @see javax.help.JHelpNavigator
* @see javax.help.HelpVisitListener
*/
public abstract class WindowPresentation extends Presentation {
private HelpSet.Presentation hsPres=null;
private JFrame frame = null;
private JHelp jhelp = null;
private JDialog dialog = null;
private Window ownerWindow = null;
private boolean modallyActivated = false;
private Point location = null;
private String title = null;
private Image image = null;
private String currentView = null;
private boolean viewDisplayed = true;
private boolean toolbarDisplayed = true;
private boolean destroyOnExit = false;
private boolean titleFromDocument = false;
private WindowPropertyChangeListener propertyChangeListener = null;
private int screen = 0;
public WindowPresentation (HelpSet hs) {
setHelpSet(hs);
}
/**
* Set the Presentation attributes specific to WindowPresentations from a
* named presentation in a HelpSet.
*
* @params hsPres - the HelpSet.Presentation to retrieve the presentation
* information from
*
* @see HelpSet.Presentation
*/
public void setHelpSetPresentation (HelpSet.Presentation hsPres) {
debug("setHelpSetPrsentation");
if (hsPres == null) {
return;
}
// make sure the underlying presentation attributes are set
super.setHelpSetPresentation(hsPres);
// get the presentation location
Point location = hsPres.getLocation();
if (location != null) {
setLocation(location);
}
// get the Title
String title = hsPres.getTitle();
if (title != null) {
setTitle(title);
}
// get the imageID
javax.help.Map.ID imageID = hsPres.getImageID();
if (imageID != null) {
ImageIcon icon = null;
try {
javax.help.Map map = getHelpSet().getCombinedMap();
URL url = map.getURLFromID(imageID);
icon = new ImageIcon(url);
image = icon.getImage();
} catch (Exception e) {
}
}
if (hsPres.isToolbar()) {
setToolbarDisplayed(true);
}
if (hsPres.isViewDisplayed()) {
setViewDisplayed(true);
}
this.hsPres = hsPres;
}
/**
* Return the HelpSet.Presentation if one was set
* @returns HelpSet.Presentation - the HelpSet.Presentation used in this
* Presentation.
*
* @see HelpSet.Presentation
*/
public HelpSet.Presentation getHelpSetPresentation() {
return hsPres;
}
/**
* Get the activation window.
*
* @returns Window - the activation window if activatated from a modal
* modal dialog, otherwise null.
*/
public Window getActivationWindow() {
debug("getActivationWindow");
return ownerWindow;
}
/**
* Set the activation window. If the window is an instance of a
* Dialog and the is modal, modallyActivated help is set to true and
* ownerDialog is set to the window. In all other instances
* modallyActivated is set to false and ownerDialog is set to null.
* @param window the activating window
*/
public void setActivationWindow(Window window) {
debug("setActivationWindow");
if (window != null && window instanceof Dialog) {
Dialog tmpDialog = (Dialog) window;
if (tmpDialog.isModal()) {
ownerWindow = window;
modallyActivated = true;
} else {
ownerWindow = null;
modallyActivated = false;
}
} else {
ownerWindow = null;
modallyActivated = false;
}
}
/**
* Set the activation window from given Component or MenuItem. It find Window component
* in the component tree from given Component or MenuItem end call
* setActivationWindow
.
* @parem comp the activation Component or MenuItem
* @since 2.0
*
* @see setActivationWindow
*/
public void setActivationObject(Object comp) {
debug("setActivationObject");
while (comp instanceof MenuComponent) {
comp = ((MenuComponent)comp).getParent();
}
Window owner = null;
if (comp instanceof Frame) {
owner = (Window)comp;
} else if (comp instanceof Component) {
owner = SwingUtilities.windowForComponent((Component)comp);
}
setActivationWindow(owner);
}
/**
* Determines the current navigator.
*/
public String getCurrentView() {
debug("getCurrentView");
// always use the current view if the jhelp exists.
if (jhelp != null) {
currentView = jhelp.getCurrentNavigator().getNavigatorName();
}
return currentView;
}
/**
* Set the currentView to the navigator with the same
* name as the name parameter.
*
* @param name The name of the navigator to set as the
* current view. If nav is null or not a valid Navigator
* in this WindowPresentation then an
* IllegalArgumentException is thrown.
* @throws IllegalArgumentException if nav is null or not a valid Navigator.
*/
public void setCurrentView(String name) {
debug("setCurrentView");
// if the jhelp already exists then set the currentview
if (jhelp != null) {
JHelpNavigator nav = getNavigatorByName(name);
if (nav == null) {
throw new IllegalArgumentException("Invalid view name");
}
jhelp.setCurrentNavigator(nav);
} else {
// jhelp didn't exist so make sure view is in HelpSet
HelpSet hs = getHelpSet();
NavigatorView view = hs.getNavigatorView(name);
if (view == null) {
throw new IllegalArgumentException("Invalid view name");
}
}
currentView = name;
}
/*
* Internal method to return a Navigator by name from a jhelp
*/
private JHelpNavigator getNavigatorByName(String name) {
JHelpNavigator nav = null;
if (jhelp != null) {
for (Enumeration e = jhelp.getHelpNavigators();
e.hasMoreElements(); ) {
nav = (JHelpNavigator) e.nextElement();
if (nav.getNavigatorName().equals(name)) {
break;
}
nav = null;
}
}
return nav;
}
/**
* Determines if the presentation should be distroyed on exit
*/
public boolean isDestroyedOnExit() {
debug("isDestoryedOnExit");
return destroyOnExit;
}
/**
* Destory the window on exit
*/
public void setDestroyOnExit(boolean destroy) {
debug("setDestoryOnExit");
destroyOnExit = destroy;
}
/**
* Destroy this object. Implementation of WindowPresentation that
* maintian a list of objects should override this method and call
* super.destroy to clear up the WindowPresentation internal fields.
*/
public void destroy() {
frame = null;
jhelp = null;
dialog = null;
ownerWindow = null;
location = null;
title = null;
currentView = null;
propertyChangeListener = null;
screen = 0;
}
/**
* Changes the HelpSet for this presentation.
* @param hs The HelpSet to set for this presentation.
* A null hs is valid parameter.
*/
public void setHelpSet(HelpSet hs) {
debug("setHelpSet");
HelpSet helpset = super.getHelpSet();
// If we already have a model check if the HelpSet has changed.
// If so change the model
// This could be made smarter to cache the helpmodels per HelpSet
if (hs != null && helpset != hs) {
super.setHelpSet(hs);
if (jhelp != null) {
jhelp.setModel(super.getHelpModel());
}
}
}
/**
* Displays the presentation to the user.
*/
public void setDisplayed(boolean b) {
debug ("setDisplayed");
// if the jhelp is null and they don't want it displayed just return
if (jhelp == null && !b) {
return;
}
// The call to createHelpWindow is necessary as the modality
// might have been changed and we need to change from a dialog
// to a frame. This is only done in createHelpWindow.
createHelpWindow();
if (modallyActivated) {
if (b) {
dialog.show();
} else {
dialog.hide();
}
} else {
frame.setVisible(b);
// We should be able to just
// try {
// frame.setState(Frame.NORMAL)
// } catch (NoSuchMethodError ex) {
// }
// but IE4.0 barfs very badly at this
// So...
try {
Class types[] = {Integer.TYPE};
Method m = Frame.class.getMethod("setState", types);
if (m != null) {
Object args[] = {new Integer(0)}; // Frame.NORMAL
m.invoke(frame, args);
}
} catch (NoSuchMethodError ex) {
// as in JDK1.1
} catch (NoSuchMethodException ex) {
// as in JDK1.1
} catch (java.lang.reflect.InvocationTargetException ex) {
//
} catch (java.lang.IllegalAccessException ex) {
//
}
}
}
/**
* Determines if the presentation is displayed.
*/
public boolean isDisplayed() {
debug ("isDisplayed");
if (jhelp == null) {
return false;
}
if (modallyActivated) {
if (dialog != null) {
return dialog.isShowing();
} else {
return false;
}
} else {
if (frame != null) {
if (! frame.isShowing()) {
return false;
}
else {
// We should be able to just
// try {
// return (frame.getState() == Frame.NORMAL)
// } catch (NoSuchMethodError ex) {
// }
// but IE4.0 barfs very badly at this
// So...
try {
Method m = Frame.class.getMethod("getState", null);
if (m != null) {
int value =((Integer)(m.invoke(frame, null))).intValue();
if (value == 0)
return true;
else
return false;
}
} catch (NoSuchMethodError ex) {
// as in JDK1.1
} catch (NoSuchMethodException ex) {
// as in JDK1.1
} catch (java.lang.reflect.InvocationTargetException ex) {
//
} catch (java.lang.IllegalAccessException ex) {
//
}
// On 1.1 I can't tell if it's raised or not.
// It's on the screen so true.
return true;
}
} else {
return false;
}
}
}
/**
* Sets the font for this this WindowPresentation.
* @param f The font.
*/
public void setFont (Font f) {
debug("setFont");
super.setFont(f);
if (jhelp != null && f != null) {
jhelp.setFont(f);
}
}
/**
* Gets the font for this WindowPresentation
*/
public Font getFont() {
debug("getFont");
Font font = super.getFont();
if (font == null) {
if (jhelp == null) {
createHelpWindow();
}
return jhelp.getFont();
}
return font;
}
/**
* Sets the locale of this Presentation. The locale is propagated to
* the presentation.
* @param l The locale to become this component's locale. A null locale
* is the same as the defaultLocale.
* @see #getLocale
*/
public void setLocale(Locale l) {
debug("setLocale");
super.setLocale(l);
if (jhelp != null) {
jhelp.setLocale(l);
}
}
/**
* internal method to test for Xinerama mode
*/
private boolean isXinerama () {
GraphicsEnvironment ge =
GraphicsEnvironment.getLocalGraphicsEnvironment();
GraphicsDevice[] gds = ge.getScreenDevices();
if (gds.length == 1) {
return false;
} else {
for (int i=0; i