com.denova.ui
Class Marquee

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--java.awt.Window
                    |
                    +--javax.swing.JWindow
                          |
                          +--com.denova.ui.Marquee

All Implemented Interfaces:

javax.accessibility.Accessible, java.awt.image.ImageObserver, java.awt.MenuContainer, javax.swing.RootPaneContainer, java.io.Serializable

public class Marquee

extends javax.swing.JWindow

A window with an image as the background and text in the foreground. The text will display within the top and bottom margins. The background filename must be defined before the getPanel() or showPanel() is called. All other attributes are optional, including the text. If the close button's label is defined, then a button is shown at the bottom of the window. Copyright © 1997-2008 DeNova All rights reserved worldwide.
Last modified: 2008.02.16

Author:

DeNova

See Also:

Serialized Form

Field Summary

Fields inherited from class javax.swing.JWindow

accessibleContext, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Marquee()

Method Summary

void	exit() Close the window.
javax.swing.JButton	getCloseButton() Gets the close button.
javax.swing.JPanel	getPanel() Gets the panel with the icon and text, if the text was defined.
void	setBackgroundColor(java.awt.Color color) Sets the background color.
void	setBackgroundFilename(java.lang.String filename) Sets the background filename.
void	setBottomMargin(int margin) Sets the bottom margin.
void	setBottomText(java.lang.String line) Sets the bottom text.
void	setCloseLabel(java.lang.String label) Sets the close label.
void	setCloseTip(java.lang.String tip) Sets the close tip.
void	setDefaultButton(boolean set) Sets the default button.
void	setFontName(java.lang.String newName) Sets the font.
void	setFontSize(int newSize) Sets the size of the font.
void	setLeftMargin(int margin) Sets the left margin.
void	setRightMargin(int margin) Sets the right margin.
void	setText(java.util.List newText) Sets the text filename.
void	setTextColor(java.awt.Color color) Sets the text color.
void	setTopMargin(int margin) Sets the top margin.
void	showWindow() Show the window.
javax.swing.JPanel	updatePanel() Update the window.

Methods inherited from class javax.swing.JWindow

addImpl, createRootPane, getAccessibleContext, getContentPane, getGlassPane, getLayeredPane, getRootPane, isRootPaneCheckingEnabled, paramString, remove, setContentPane, setGlassPane, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, update, windowInit

Methods inherited from class java.awt.Window

addNotify, addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, finalize, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getInputContext, getListeners, getLocale, getMostRecentFocusOwner, getOwnedWindows, getOwner, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindowStateListeners, hide, isActive, isFocusableWindow, isFocusCycleRoot, isFocused, isShowing, pack, postEvent, processEvent, processWindowEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, setCursor, setFocusableWindowState, setFocusCycleRoot, setLocationRelativeTo, show, toBack, toFront

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, removeNotify, setFocusTraversalKeys, setFocusTraversalPolicy, setFont, transferFocusBackward, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isOpaque, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, setBackground, setBounds, setBounds, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, setVisible, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Marquee

public Marquee()

Method Detail

showWindow

public void showWindow()

Show the window. You must provide a way to terminate this window or you can simply setCloseLabel() so the close button is created and the user can close the window.

getPanel

public javax.swing.JPanel getPanel()

Gets the panel with the icon and text, if the text was defined.

Returns:

panel

updatePanel

public javax.swing.JPanel updatePanel()

Update the window.

exit

public void exit()

Close the window.

getCloseButton

public javax.swing.JButton getCloseButton()

Gets the close button.

Returns:

close button

setBackgroundFilename

public void setBackgroundFilename(java.lang.String filename)

Sets the background filename.

Parameters:

filename - new background filename

setBackgroundColor

public void setBackgroundColor(java.awt.Color color)

Sets the background color.

Parameters:

color - new background color

setText

public void setText(java.util.List newText)

Sets the text filename.

Parameters:

newText - new text filenames

setTextColor

public void setTextColor(java.awt.Color color)

Sets the text color.

Parameters:

color - new text color

setFontName

public void setFontName(java.lang.String newName)

Sets the font. If the font is not set or the font's name isn't known by the LAF, then the "label" font is used.

Parameters:

newName - new name of font.

setFontSize

public void setFontSize(int newSize)

Sets the size of the font. If you want to use the default font size for the "label" font, then set the font to 0.

Parameters:

newSize - new size

setBottomText

public void setBottomText(java.lang.String line)

Sets the bottom text.

Parameters:

line - new bottom text

setTopMargin

public void setTopMargin(int margin)

Sets the top margin.

Parameters:

margin - new top margin

setBottomMargin

public void setBottomMargin(int margin)

Sets the bottom margin.

Parameters:

margin - new bottom margin

setLeftMargin

public void setLeftMargin(int margin)

Sets the left margin.

Parameters:

margin - new left margin

setRightMargin

public void setRightMargin(int margin)

Sets the right margin.

Parameters:

margin - new right margin

setCloseLabel

public void setCloseLabel(java.lang.String label)

Sets the close label.

Parameters:

label - new close label

setCloseTip

public void setCloseTip(java.lang.String tip)

Sets the close tip.

Parameters:

tip - new close tip

setDefaultButton

public void setDefaultButton(boolean set)

Sets the default button.

Parameters:

set - new default button