echopoint
Class ToolTipPopUp

java.lang.Object
  nextapp.echo.Component
      nextapp.echo.Container
          echopoint.DevNull
              echopoint.ToolTipPopUp

All Implemented Interfaces:

ReflectionSetter, java.io.Serializable

public class ToolTipPopUp

extends DevNull

ToolTipPopUp is a component that can help render rich tool tips when the mouse goes over a Component. The ToolTipPopUp component is used to cutomise what this tool tip looks like and how it acts.

The component is intended as a support component for other components to use in order to implement the ToolTipPopUpSupport interface. It is not intended to be used on its own per se. Since it is derived from DevNull it does not render anything on its own.

To use the component in another component do the following :

1. Have the parent component implement ToolTipPopUpSupport
2. Added a ToolTipPopUp as a field of the parent Component and make sure this ToolTipPopUp is a child of the parent
3. Initialise a new ToolTipPopUp into this field in the constructor. See above
4. Override validate and add the ToolTipPopUp if its not already a child
5. Override the getToolTipText to called ToolTipPopUp.getToolTipText()
6. Override the setToolTipText to called ToolTipPopUp.setToolTipText()
7. Override the getToolTipPopUp to return the child ToolTipPopUp

You can look at the source of PushButton as an example of adding this support.

If you want the tool tip support to act like the previous default browser tool tips then you will need to call setComplexRendering(false);. By default it is on.

Author:

Georg Sendt (georg.sendt@web.de) (originally)

See Also:

ToolTipPopUpSupport, PushButton, Serialized Form

Nested Class Summary

static class

ToolTipPopUp.NestedStyleInfo Nested public static StyleInfo class.

Field Summary

static java.lang.String	AUTOSTATUS_CHANGED_PROPERTY
static java.lang.String	AUTOSTATUSCAPTION_CHANGED_PROPERTY
static java.lang.String	BACKGROUND_IMAGE_CHANGED_PROPERTY
static java.lang.String	BORDER_COLOR_CHANGED_PROPERTY
static java.lang.String	BORDER_IMAGE_CHANGED_PROPERTY
static java.lang.String	BORDER_SIZE_CHANGED_PROPERTY
static java.lang.String	BROWSER_STATUS_BAR_TEXT_CHANGED_PROPERTY
static java.lang.String	CAPTION_COLOR_CHANGED_PROPERTY
static java.lang.String	CAPTION_FONT_PROPERTY_CHANGED
static java.lang.String	CAPTION_ICON_CHANGED_PROPERTY
static java.lang.String	CAPTION_TEXT_CHANGED_PROPERTY
static java.lang.String	CLOSE_COLOR_PROPERTY_CHANGED
static java.lang.String	CLOSE_FONT_CHANGED_PROPERTY
static java.lang.String	CLOSE_TEXT_CHANGED_PROPERTY
static java.lang.String	CSS_SUPPORT_CHANGED_PROPERTY
static nextapp.echo.Color	DEFAULT_BACKGROUND The default background color of the tool tip.
static int	DEFAULT_DELAY The default delay is 600 milliseconds.
static nextapp.echo.Color	DEFAULT_TEXT_BACKGROUND The default text color of the tool tip.
static int	DEFAULT_TIMEOUT The default time is -1.
static java.lang.String	DELAY_CHANGED_PROPERTY
static java.lang.String	FIXX_CHANGED_PROPERTY
static java.lang.String	FIXY_CHANGED_PROPERTY
static java.lang.String	FORCE_CLOSE_ENABLED_PROPERTY_CHANGED
static java.lang.String	FULLHTML_ENABLED_PROPERTY_CHANGED
static java.lang.String	HEIGHT_CHANGED_PROPERTY
static java.lang.String	HORIZONTAL_AUTO_POSITION_CHANGED_PROPERTY
static java.lang.String	HOVERABLE_CHANGED_PROPERTY
static java.lang.String	INSIDE_COLOR_CHANGED_PROPERTY
static java.lang.String	INSIDE_IMAGE_CHANGED_PROPERTY
static java.lang.String	NO_CLOSE_TEXT_CHANGED_PROPERTY
static java.lang.String	OFFSETX_PROPERTY_CHANGED
static java.lang.String	OFFSETY_PROPERTY_CHANGED
static java.lang.String	PADX_CHANGED_PROPERTY
static java.lang.String	PADY_CHANGED_PROPERTY
static java.lang.String	POPUP_HORIZONTAL_ALIGNMENT_CHANGED_PROPERTY
static java.lang.String	POPUP_VERTICAL_ALIGNMENT
static java.lang.String	RENDERING_CHANGED_PROPERTY
static java.lang.String	SNAPX_CHANGED_PROPERTY
static java.lang.String	SNAPY_CHANGED_PROPERTY
static java.lang.String	STICKY_CHANGED_PROPERTY
static java.lang.String	STYLE_AUTOSTATUS A style constant for the AutoStatus property.
static java.lang.String	STYLE_AUTOSTATUSCAPTION A style constant for the AutoStatusCaption property.
static java.lang.String	STYLE_BACKGROUND_IMAGE A style constant for the Background Image property.
static java.lang.String	STYLE_BORDER_COLOR A style constant for the Border Color property.
static java.lang.String	STYLE_BORDER_IMAGE A style constant for the Border Image property.
static java.lang.String	STYLE_BORDER_SIZE A style constant for the Border Size property.
static java.lang.String	STYLE_BROWSER_STATUS_BAR_TEXT A style constant for the Browser StatusBar Text property.
static java.lang.String	STYLE_CAPTION_COLOR A style constant for the Caption Color property.
static java.lang.String	STYLE_CAPTION_FONT A style constant for the Caption Font property.
static java.lang.String	STYLE_CAPTION_ICON A style constant for the Caption Icon property.
static java.lang.String	STYLE_CAPTION_TEXT A style constant for the CaptionText property.
static java.lang.String	STYLE_CLOSE_COLOR A style constant for the Close Color property.
static java.lang.String	STYLE_CLOSE_FONT A style constant for the Close Font property.
static java.lang.String	STYLE_CLOSE_TEXT A style constant for the Close Text property.
static java.lang.String	STYLE_CSS_SUPPORT A style constant for the CSS Support property.
static java.lang.String	STYLE_DELAY A style constant for the Delay property.
static java.lang.String	STYLE_FIXX A style constant for the absolute horizontal position property.
static java.lang.String	STYLE_FIXY A style constant for the absolute vertical position property.
static java.lang.String	STYLE_FORCE_CLOSE_ENABLED A style constant for the ForceCloseEnabled property.
static java.lang.String	STYLE_FULLHTML_ENABLED A style constant for the FullHtmlEnabled property.
static java.lang.String	STYLE_HEIGHT A style constant for the Height property.
static java.lang.String	STYLE_HORIZONTAL_AUTO_POSITION A style constant for the Horizontal Auto Position property.
static java.lang.String	STYLE_HOVERABLE A style constant for the Hoverable property.
static java.lang.String	STYLE_INSIDE_COLOR A style constant for the Inside Color property.
static java.lang.String	STYLE_INSIDE_IMAGE A style constant for the Inside Image property.
static java.lang.String	STYLE_NO_CLOSE_TEXT A style constant for the NoCloseText property.
static java.lang.String	STYLE_OFFSETX A style constant for the OffsetX property.
static java.lang.String	STYLE_OFFSETY A style constant for the OffsetY property.
static java.lang.String	STYLE_PADX A style constant for the PadX property.
static java.lang.String	STYLE_PADY A style constant for the PadY property.
static java.lang.String	STYLE_POPUP_HORIZONTAL_ALIGNMENT A style constant for the Popup Horizontal Alignment property.
static java.lang.String	STYLE_POPUP_VERTICAL_ALIGNMENT A style constant for the Popup Vertical Alignment property.
static java.lang.String	STYLE_SNAPX A style constant for the SnapX property.
static java.lang.String	STYLE_SNAPY A style constant for the SnapY property.
static java.lang.String	STYLE_STICKY A style constant for the Sticky property.
static java.lang.String	STYLE_TIMEOUT A style constant for the Timeout property.
static java.lang.String	STYLE_TOOLTIP_TEXT A style constant for the Popup Text property.
static java.lang.String	STYLE_TOOLTIP_TEXT_COLOR A style constant for the Popup Text Color property.
static java.lang.String	STYLE_TOOLTIP_TEXT_FONT A style constant for the Popup Text Font property.
static java.lang.String	STYLE_VERTICAL_AUTO_POSITION A style constant for the Vertical Auto Position property Values of this key must be of type boolean
static java.lang.String	STYLE_WIDTH A style constant for the Width property.
static java.lang.String	TIMEOUT_CHANGED_PROPERTY
static java.lang.String	TOOLTIP_TEXT_CHANGED_PROPERTY
static java.lang.String	TOOLTIP_TEXT_COLOR_CHANGED_PROPERTY
static java.lang.String	TOOLTIP_TEXT_FONT_CHANGED_PROPERTY
static java.lang.String	VERTICAL_AUTO_POSITION_CHANGED_PROPERTY
static java.lang.String	WIDTH_CHANGED_PROPERTY

Fields inherited from class nextapp.echo.Component

BACKGROUND_CHANGED_PROPERTY, CHILDREN_CHANGED_PROPERTY, ENABLED_CHANGED_PROPERTY, FONT_CHANGED_PROPERTY, FOREGROUND_CHANGED_PROPERTY, IDENTIFIER_CHANGED_PROPERTY, listenerList, LOCALE_CHANGED_PROPERTY, MODEL_CHANGED_PROPERTY, STYLE_BACKGROUND, STYLE_FONT, STYLE_FOREGROUND, UPDATE_PROPERTY, VISIBLE_CHANGED_PROPERTY

Constructor Summary

ToolTipPopUp()
Constructs a ToolTipPopUp

ToolTipPopUp(java.lang.String toolTipText)
Constructs a ToolTipPopUp

Method Summary

void	applyStyle(nextapp.echo.Style style) Applies the provided style to the component.
nextapp.echo.ImageReference	getBackgroundImage()
nextapp.echo.Color	getBorderColor()
nextapp.echo.ImageReference	getBorderImage()
int	getBorderSize()
java.lang.String	getBrowserStatusBarText()
nextapp.echo.Color	getCaptionColor()
nextapp.echo.Font	getCaptionFont()
nextapp.echo.ImageReference	getCaptionIcon()
java.lang.String	getCaptionText()
nextapp.echo.Color	getCloseColor()
nextapp.echo.Font	getCloseFont()
java.lang.String	getCloseText()
int	getDelay()
int	getHeight()
int	getHorizontalPositionLock()
nextapp.echo.Color	getInsideColor()
nextapp.echo.ImageReference	getInsideImage()
int	getOffsetX()
int	getOffsetY()
int[]	getPadX()
int[]	getPadY()
int	getPopupHorizontalAlignment() Makes the popups go to the left of the mouse
int	getPopupVerticalAlignment() Makes the popups go above the mouse.
int	getSnapX()
int	getSnapY()
int	getTimeout()
java.lang.String	getToolTipText()
nextapp.echo.Color	getToolTipTextColor()
nextapp.echo.Font	getToolTipTextFont()
int	getVerticalPositionLock()
int	getWidth()
boolean	isAutoStatus()
boolean	isAutoStatusCaption()
boolean	isComplexRendering() Controls whether the ToolTipPopUp will be rendered for using all the complex behaviour or whether it will default back to the client browser default from previous versions.
boolean	isCssSupport()
boolean	isForceCloseEnabled() Force users to click on "Close" to close sticky popups.
boolean	isFullHtmlEnabled()
boolean	isHorizontalAutoPositionEnabled()
boolean	isHoverable()
boolean	isNoCloseText()
boolean	isSticky()
boolean	isVerticalAutoPositionEnabled()
java.lang.Object	set(java.lang.reflect.Field field, java.lang.Object newValue) Called to save the old value of a field, set in a new value and return the old value of a field.
void	setAutoStatus(boolean newValue) Sets the status bar's text to the popup's text.
void	setAutoStatusCaption(boolean newValue) Sets the status bar's text to the popup's caption.
void	setBackgroundImage(nextapp.echo.ImageReference newValue) Instead of using the table box as background, your picture will be used.
void	setBorderColor(nextapp.echo.Color newValue) Color of the border of the popup box.
void	setBorderImage(nextapp.echo.ImageReference newValue) Defines a picture to use instead of color for the border of the popup.
void	setBorderSize(int newValue) Makes the border of the popups thicker or thinner.
void	setBrowserStatusBarText(java.lang.String newValue) Sets the text in the browsers status bar to text.
void	setCaptionColor(nextapp.echo.Color newValue) Sets the color of the box's caption.
void	setCaptionFont(nextapp.echo.Font newValue) Sets the font of the caption.
void	setCaptionIcon(nextapp.echo.ImageReference newValue) Displays a small icon before the popup caption.
void	setCaptionText(java.lang.String newValue) caption text of popup
void	setCloseColor(nextapp.echo.Color newValue) Sets the color of the "Close" text.
void	setCloseFont(nextapp.echo.Font newValue) Defines the font for the "Close" text.
void	setCloseText(java.lang.String newValue) Replaces the text "Close" with something else.
void	setComplexRendering(boolean newRendering) Controls whether the ToolTipPopUp will be rendered for using all the complex behaviour or whether it will default back to the client browser default from previous versions.
void	setCssSupport(boolean newValue) toggle CSS support for fonts.
void	setDelay(int milliseconds) Makes that popup behave like a tooltip.
void	setFixX(int x) Locks the popups horizontal position.
void	setFixY(int y) Locks the popups vertical position.
void	setForceCloseEnabled(boolean newValue) Force users to click on "Close" to close sticky popups.
void	setFullHtmlEnabled(boolean newValue) Allows you to control the html over a BACKGROUND picture completely.
void	setHeight(int newValue) Sets the height of the box.
void	setHorizontalAutoPositionEnabled(boolean newValue) Automatically determine if the popup should be to the left or right of the mouse.
void	setHoverable(boolean newValue) toggle popup behaviour between to hoverable (default) and clickable
void	setInsideColor(nextapp.echo.Color newValue) Color of the inside of the popup box.
void	setInsideImage(nextapp.echo.ImageReference newValue) Defines a picture to use instead of color for the inside of the popup.
void	setNoCloseText(boolean newValue) Doesn't display the text "Close" on stickies with caption.
void	setOffsetX(int newValue) How far away from the pointer the popup will show up, horizontally.
void	setOffsetY(int newValue) How far away from the pointer the popup will show up, vertically.
void	setPadX(int left, int right) Pads the background picture with horizontal whitespace for text placement.
void	setPadY(int bottom, int top) Pads the background picture with vertical whitespace for text placement.
void	setPopupHorizontalAlignment(int newValue) Makes the popups go to the left of the mouse
void	setPopupVerticalAlignment(int newValue) Makes the popups go above/below the mouse.
void	setSnapX(int newValue) Snaps the popup to an even position in a horizontal grid.
void	setSnapY(int newValue) Snaps the popup to an even position in a vertical grid.
void	setSticky(boolean newValue) Makes the popup stick around until closed.
void	setTimeout(int milliseconds) Makes the popup go away after the requested delay.
void	setToolTipText(java.lang.String newValue) text to display in popup
void	setToolTipTextColor(nextapp.echo.Color newValue) Sets the color of the text inside the box.
void	setToolTipTextFont(nextapp.echo.Font newValue) Sets the font of the text inside the box
void	setVerticalAutoPositionEnabled(boolean newValue) Automatically determine if the popup should be to the above or below of the mouse.
void	setWidth(int newValue) Sets the width of the box to some other size

Methods inherited from class echopoint.DevNull

setVisible

Methods inherited from class nextapp.echo.Component

add, add, addHierarchyListener, addPropertyChangeListener, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getComponent, getComponentCount, getComponents, getEchoInstance, getFont, getForeground, getIdentifier, getLocale, getParent, indexOf, init, isAncestorOf, isEnabled, isRegistered, isShowing, isVisible, remove, remove, removeAll, removeHierarchyListener, removePropertyChangeListener, setBackground, setEnabled, setFont, setForeground, setIdentifier, setLocale, update, validate

Methods inherited from class java.lang.Object

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

Field Detail

AUTOSTATUS_CHANGED_PROPERTY

public static final java.lang.String AUTOSTATUS_CHANGED_PROPERTY

See Also:

Constant Field Values

AUTOSTATUSCAPTION_CHANGED_PROPERTY

public static final java.lang.String AUTOSTATUSCAPTION_CHANGED_PROPERTY

See Also:

Constant Field Values

BACKGROUND_IMAGE_CHANGED_PROPERTY

public static final java.lang.String BACKGROUND_IMAGE_CHANGED_PROPERTY

See Also:

Constant Field Values

BORDER_COLOR_CHANGED_PROPERTY

public static final java.lang.String BORDER_COLOR_CHANGED_PROPERTY

See Also:

Constant Field Values

BORDER_IMAGE_CHANGED_PROPERTY

public static final java.lang.String BORDER_IMAGE_CHANGED_PROPERTY

See Also:

Constant Field Values

BORDER_SIZE_CHANGED_PROPERTY

public static final java.lang.String BORDER_SIZE_CHANGED_PROPERTY

See Also:

Constant Field Values

BROWSER_STATUS_BAR_TEXT_CHANGED_PROPERTY

public static final java.lang.String BROWSER_STATUS_BAR_TEXT_CHANGED_PROPERTY

See Also:

Constant Field Values

CAPTION_COLOR_CHANGED_PROPERTY

public static final java.lang.String CAPTION_COLOR_CHANGED_PROPERTY

See Also:

Constant Field Values

CAPTION_FONT_PROPERTY_CHANGED

public static final java.lang.String CAPTION_FONT_PROPERTY_CHANGED

See Also:

Constant Field Values

CAPTION_ICON_CHANGED_PROPERTY

public static final java.lang.String CAPTION_ICON_CHANGED_PROPERTY

See Also:

Constant Field Values

CAPTION_TEXT_CHANGED_PROPERTY

public static final java.lang.String CAPTION_TEXT_CHANGED_PROPERTY

See Also:

Constant Field Values

CLOSE_COLOR_PROPERTY_CHANGED

public static final java.lang.String CLOSE_COLOR_PROPERTY_CHANGED

See Also:

Constant Field Values

CLOSE_FONT_CHANGED_PROPERTY

public static final java.lang.String CLOSE_FONT_CHANGED_PROPERTY

See Also:

Constant Field Values

CLOSE_TEXT_CHANGED_PROPERTY

public static final java.lang.String CLOSE_TEXT_CHANGED_PROPERTY

See Also:

Constant Field Values

CSS_SUPPORT_CHANGED_PROPERTY

public static final java.lang.String CSS_SUPPORT_CHANGED_PROPERTY

See Also:

Constant Field Values

DELAY_CHANGED_PROPERTY

public static final java.lang.String DELAY_CHANGED_PROPERTY

See Also:

Constant Field Values

FIXX_CHANGED_PROPERTY

public static final java.lang.String FIXX_CHANGED_PROPERTY

See Also:

Constant Field Values

FIXY_CHANGED_PROPERTY

public static final java.lang.String FIXY_CHANGED_PROPERTY

See Also:

Constant Field Values

FORCE_CLOSE_ENABLED_PROPERTY_CHANGED

public static final java.lang.String FORCE_CLOSE_ENABLED_PROPERTY_CHANGED

See Also:

Constant Field Values

FULLHTML_ENABLED_PROPERTY_CHANGED

public static final java.lang.String FULLHTML_ENABLED_PROPERTY_CHANGED

See Also:

Constant Field Values

HEIGHT_CHANGED_PROPERTY

public static final java.lang.String HEIGHT_CHANGED_PROPERTY

See Also:

Constant Field Values

HORIZONTAL_AUTO_POSITION_CHANGED_PROPERTY

public static final java.lang.String HORIZONTAL_AUTO_POSITION_CHANGED_PROPERTY

See Also:

Constant Field Values

HOVERABLE_CHANGED_PROPERTY

public static final java.lang.String HOVERABLE_CHANGED_PROPERTY

See Also:

Constant Field Values

INSIDE_COLOR_CHANGED_PROPERTY

public static final java.lang.String INSIDE_COLOR_CHANGED_PROPERTY

See Also:

Constant Field Values

INSIDE_IMAGE_CHANGED_PROPERTY

public static final java.lang.String INSIDE_IMAGE_CHANGED_PROPERTY

See Also:

Constant Field Values

NO_CLOSE_TEXT_CHANGED_PROPERTY

public static final java.lang.String NO_CLOSE_TEXT_CHANGED_PROPERTY

See Also:

Constant Field Values

OFFSETX_PROPERTY_CHANGED

public static final java.lang.String OFFSETX_PROPERTY_CHANGED

See Also:

Constant Field Values

OFFSETY_PROPERTY_CHANGED

public static final java.lang.String OFFSETY_PROPERTY_CHANGED

See Also:

Constant Field Values

PADX_CHANGED_PROPERTY

public static final java.lang.String PADX_CHANGED_PROPERTY

See Also:

Constant Field Values

PADY_CHANGED_PROPERTY

public static final java.lang.String PADY_CHANGED_PROPERTY

See Also:

Constant Field Values

POPUP_HORIZONTAL_ALIGNMENT_CHANGED_PROPERTY

public static final java.lang.String POPUP_HORIZONTAL_ALIGNMENT_CHANGED_PROPERTY

See Also:

Constant Field Values

TOOLTIP_TEXT_CHANGED_PROPERTY

public static final java.lang.String TOOLTIP_TEXT_CHANGED_PROPERTY

See Also:

Constant Field Values

TOOLTIP_TEXT_COLOR_CHANGED_PROPERTY

public static final java.lang.String TOOLTIP_TEXT_COLOR_CHANGED_PROPERTY

See Also:

Constant Field Values

TOOLTIP_TEXT_FONT_CHANGED_PROPERTY

public static final java.lang.String TOOLTIP_TEXT_FONT_CHANGED_PROPERTY

See Also:

Constant Field Values

POPUP_VERTICAL_ALIGNMENT

public static final java.lang.String POPUP_VERTICAL_ALIGNMENT

See Also:

Constant Field Values

SNAPX_CHANGED_PROPERTY

public static final java.lang.String SNAPX_CHANGED_PROPERTY

See Also:

Constant Field Values

SNAPY_CHANGED_PROPERTY

public static final java.lang.String SNAPY_CHANGED_PROPERTY

See Also:

Constant Field Values

STICKY_CHANGED_PROPERTY

public static final java.lang.String STICKY_CHANGED_PROPERTY

See Also:

Constant Field Values

TIMEOUT_CHANGED_PROPERTY

public static final java.lang.String TIMEOUT_CHANGED_PROPERTY

See Also:

Constant Field Values

VERTICAL_AUTO_POSITION_CHANGED_PROPERTY

public static final java.lang.String VERTICAL_AUTO_POSITION_CHANGED_PROPERTY

See Also:

Constant Field Values

WIDTH_CHANGED_PROPERTY

public static final java.lang.String WIDTH_CHANGED_PROPERTY

See Also:

Constant Field Values

RENDERING_CHANGED_PROPERTY

public static final java.lang.String RENDERING_CHANGED_PROPERTY

See Also:

Constant Field Values

STYLE_AUTOSTATUS

public static final java.lang.String STYLE_AUTOSTATUS

A style constant for the AutoStatus property. Values of this key must be of type boolean

See Also:

Constant Field Values

STYLE_AUTOSTATUSCAPTION

public static final java.lang.String STYLE_AUTOSTATUSCAPTION

A style constant for the AutoStatusCaption property. Values of this key must be of type boolean

See Also:

Constant Field Values

STYLE_BORDER_COLOR

public static final java.lang.String STYLE_BORDER_COLOR

A style constant for the Border Color property. Values of this key must be of type nextapp.echo.Color.

See Also:

Constant Field Values

STYLE_BORDER_SIZE

public static final java.lang.String STYLE_BORDER_SIZE

A style constant for the Border Size property. Values of this key must be of type int

See Also:

Constant Field Values

STYLE_CAPTION_COLOR

public static final java.lang.String STYLE_CAPTION_COLOR

A style constant for the Caption Color property. Values of this key must be of type nextapp.echo.Color.

See Also:

Constant Field Values

STYLE_CAPTION_FONT

public static final java.lang.String STYLE_CAPTION_FONT

A style constant for the Caption Font property. Values of this key must be of type nextapp.echo.Font

See Also:

Constant Field Values

STYLE_FORCE_CLOSE_ENABLED

public static final java.lang.String STYLE_FORCE_CLOSE_ENABLED

A style constant for the ForceCloseEnabled property. Values of this key must be of type

See Also:

Constant Field Values

STYLE_CLOSE_COLOR

public static final java.lang.String STYLE_CLOSE_COLOR

A style constant for the Close Color property. Values of this key must be of type nextapp.echo.Color.

See Also:

Constant Field Values

STYLE_CLOSE_FONT

public static final java.lang.String STYLE_CLOSE_FONT

A style constant for the Close Font property. Values of this key must be of type nextapp.echo.Font.

See Also:

Constant Field Values

STYLE_CLOSE_TEXT

public static final java.lang.String STYLE_CLOSE_TEXT

A style constant for the Close Text property. Values of this key must be of type String

See Also:

Constant Field Values

STYLE_CSS_SUPPORT

public static final java.lang.String STYLE_CSS_SUPPORT

A style constant for the CSS Support property. Values of this key must be of type boolean

See Also:

Constant Field Values

STYLE_POPUP_HORIZONTAL_ALIGNMENT

public static final java.lang.String STYLE_POPUP_HORIZONTAL_ALIGNMENT

A style constant for the Popup Horizontal Alignment property. Values of this key must be of type int

See Also:

Constant Field Values

STYLE_HORIZONTAL_AUTO_POSITION

public static final java.lang.String STYLE_HORIZONTAL_AUTO_POSITION

A style constant for the Horizontal Auto Position property. Values of this key must be of type boolean

See Also:

Constant Field Values

STYLE_DELAY

public static final java.lang.String STYLE_DELAY

A style constant for the Delay property. Values of this key must be of type int

See Also:

Constant Field Values

STYLE_INSIDE_COLOR

public static final java.lang.String STYLE_INSIDE_COLOR

A style constant for the Inside Color property. Values of this key must be of type nextapp.echo.Color.

See Also:

Constant Field Values

STYLE_FIXX

public static final java.lang.String STYLE_FIXX

A style constant for the absolute horizontal position property. Values of this key must be of type int

See Also:

Constant Field Values

STYLE_VERTICAL_AUTO_POSITION

public static final java.lang.String STYLE_VERTICAL_AUTO_POSITION

A style constant for the Vertical Auto Position property Values of this key must be of type boolean

See Also:

Constant Field Values

STYLE_FIXY

public static final java.lang.String STYLE_FIXY

A style constant for the absolute vertical position property. Values of this key must be of type int

See Also:

Constant Field Values

STYLE_FULLHTML_ENABLED

public static final java.lang.String STYLE_FULLHTML_ENABLED

A style constant for the FullHtmlEnabled property. Values of this key must be of type boolean

See Also:

Constant Field Values

STYLE_HEIGHT

public static final java.lang.String STYLE_HEIGHT

A style constant for the Height property. Values of this key must be of type int

See Also:

Constant Field Values

STYLE_HOVERABLE

public static final java.lang.String STYLE_HOVERABLE

A style constant for the Hoverable property. Values of this key must be of type boolean

See Also:

Constant Field Values

STYLE_NO_CLOSE_TEXT

public static final java.lang.String STYLE_NO_CLOSE_TEXT

A style constant for the NoCloseText property. Values of this key must be of type boolean

See Also:

Constant Field Values

STYLE_OFFSETX

public static final java.lang.String STYLE_OFFSETX

A style constant for the OffsetX property. Values of this key must be of type int

See Also:

Constant Field Values

STYLE_OFFSETY

public static final java.lang.String STYLE_OFFSETY

A style constant for the OffsetY property. Values of this key must be of type int

See Also:

Constant Field Values

STYLE_PADX

public static final java.lang.String STYLE_PADX

A style constant for the PadX property. Values of this key must be of type int[] ([0] = left, [1] = right)

See Also:

Constant Field Values

STYLE_PADY

public static final java.lang.String STYLE_PADY

A style constant for the PadY property. Values of this key must be of type int[ [0] = bottom, [1] = top)]

See Also:

Constant Field Values

STYLE_SNAPX

public static final java.lang.String STYLE_SNAPX

A style constant for the SnapX property. Values of this key must be of type int

See Also:

Constant Field Values

STYLE_SNAPY

public static final java.lang.String STYLE_SNAPY

A style constant for the SnapY property. Values of this key must be of type int

See Also:

Constant Field Values

STYLE_STICKY

public static final java.lang.String STYLE_STICKY

A style constant for the Sticky property. Values of this key must be of type boolean

See Also:

Constant Field Values

STYLE_TIMEOUT

public static final java.lang.String STYLE_TIMEOUT

A style constant for the Timeout property. Values of this key must be of type int

See Also:

Constant Field Values

STYLE_POPUP_VERTICAL_ALIGNMENT

public static final java.lang.String STYLE_POPUP_VERTICAL_ALIGNMENT

A style constant for the Popup Vertical Alignment property. Values of this key must be of type int

See Also:

Constant Field Values

STYLE_WIDTH

public static final java.lang.String STYLE_WIDTH

A style constant for the Width property. Values of this key must be of type int

See Also:

Constant Field Values

STYLE_BROWSER_STATUS_BAR_TEXT

public static final java.lang.String STYLE_BROWSER_STATUS_BAR_TEXT

A style constant for the Browser StatusBar Text property. Values of this key must be of type String

See Also:

Constant Field Values

STYLE_TOOLTIP_TEXT

public static final java.lang.String STYLE_TOOLTIP_TEXT

A style constant for the Popup Text property. Values of this key must be of type String

See Also:

Constant Field Values

STYLE_TOOLTIP_TEXT_COLOR

public static final java.lang.String STYLE_TOOLTIP_TEXT_COLOR

A style constant for the Popup Text Color property. Values of this key must be of type nextapp.echo.Color.

See Also:

Constant Field Values

STYLE_TOOLTIP_TEXT_FONT

public static final java.lang.String STYLE_TOOLTIP_TEXT_FONT

A style constant for the Popup Text Font property. Values of this key must be of type nextapp.echo.Font.

See Also:

Constant Field Values

STYLE_CAPTION_TEXT

public static final java.lang.String STYLE_CAPTION_TEXT

A style constant for the CaptionText property. Values of this key must be of type String

See Also:

Constant Field Values

STYLE_CAPTION_ICON

public static final java.lang.String STYLE_CAPTION_ICON

A style constant for the Caption Icon property. Values of this key must be of type nextapp.echo.ImageReference

See Also:

Constant Field Values

STYLE_BACKGROUND_IMAGE

public static final java.lang.String STYLE_BACKGROUND_IMAGE

A style constant for the Background Image property. Values of this key must be of type nextapp.echo.ImageReference

See Also:

Constant Field Values

STYLE_BORDER_IMAGE

public static final java.lang.String STYLE_BORDER_IMAGE

A style constant for the Border Image property. Values of this key must be of type nextapp.echo.ImageReference

See Also:

Constant Field Values

STYLE_INSIDE_IMAGE

public static final java.lang.String STYLE_INSIDE_IMAGE

A style constant for the Inside Image property. Values of this key must be of type nextapp.echo.ImageReference

See Also:

Constant Field Values

DEFAULT_BACKGROUND

public static nextapp.echo.Color DEFAULT_BACKGROUND

The default background color of the tool tip.

DEFAULT_TEXT_BACKGROUND

public static nextapp.echo.Color DEFAULT_TEXT_BACKGROUND

The default text color of the tool tip.

DEFAULT_DELAY

public static int DEFAULT_DELAY

The default delay is 600 milliseconds. This makes it act much like a tool tip, popping up after some time.

DEFAULT_TIMEOUT

public static int DEFAULT_TIMEOUT

The default time is -1. This controls when the popup goes away.

Constructor Detail

ToolTipPopUp

public ToolTipPopUp(java.lang.String toolTipText)

Constructs a ToolTipPopUp

Parameters:

toolTipText - - The text to be displayed by the ToolTipPopUp

ToolTipPopUp

public ToolTipPopUp()

Constructs a ToolTipPopUp

Method Detail

applyStyle

public void applyStyle(nextapp.echo.Style style)

Applies the provided style to the component. The base nextapp.echo.Component style names can be used as well.

getPopupHorizontalAlignment

public int getPopupHorizontalAlignment()

Makes the popups go to the left of the mouse

Returns:

EchoConstants.LEFT | EchoConstants.RIGHT (default) | EchoConstants.CENTER

isAutoStatus

public boolean isAutoStatus()

Returns:

Sets the status bar's text to the popup's text. Overrides STATUS.

isAutoStatusCaption

public boolean isAutoStatusCaption()

Returns:

Sets the status bar's text to the popup's caption. Overrides AUTOSTATUS and STATUS.

getBackgroundImage

public nextapp.echo.ImageReference getBackgroundImage()

Returns:

Instead of using the table box as background, your picture will be used.

getBorderColor

public nextapp.echo.Color getBorderColor()

Returns:

Color of the border of the popup box.

getBorderSize

public int getBorderSize()

Returns:

BorderSize

getCaptionColor

public nextapp.echo.Color getCaptionColor()

Returns:

Color of the box's caption.

getCaptionIcon

public nextapp.echo.ImageReference getCaptionIcon()

Returns:

small icon before the popup caption.

getCaptionFont

public nextapp.echo.Font getCaptionFont()

Returns:

Font of the caption.

isForceCloseEnabled

public boolean isForceCloseEnabled()

Force users to click on "Close" to close sticky popups. This command toggles the feature on and off.

Returns:

forceCloseEnabled

getCloseColor

public nextapp.echo.Color getCloseColor()

Returns:

Color of the close text.

getCloseFont

public nextapp.echo.Font getCloseFont()

Returns:

Font for the "Close" text.

getCloseText

public java.lang.String getCloseText()

Returns:

Close-Text

getDelay

public int getDelay()

Returns:

Delay in millisec after popup appear

getInsideColor

public nextapp.echo.Color getInsideColor()

Returns:

Color of the inside of the popup box.

getHorizontalPositionLock

public int getHorizontalPositionLock()

Returns:

Locks the popups horizontal position. Overrides all other horizontal placement.

getVerticalPositionLock

public int getVerticalPositionLock()

Returns:

Locks the popups vertical position. Overrides all other vertical placement.

isFullHtmlEnabled

public boolean isFullHtmlEnabled()

Returns:

FullHtml control over text output

isHorizontalAutoPositionEnabled

public boolean isHorizontalAutoPositionEnabled()

Returns:

Automatically determine if the popup should be to the left or right of the mouse.

getHeight

public int getHeight()

Returns:

height of the box.

isNoCloseText

public boolean isNoCloseText()

Returns:

Doesn't display the text "Close" on stickies with caption.

getOffsetX

public int getOffsetX()

Returns:

How far away from the pointer the popup will show up, horizontally.

getOffsetY

public int getOffsetY()

Returns:

How far away from the pointer the popup will show up, vertically.

getPadX

public int[] getPadX()

Returns:

Pads the background picture with horizontal whitespace for text placement.

getPadY

public int[] getPadY()

Returns:

Pads the background picture with vertical whitespace for text placement.

getSnapX

public int getSnapX()

Returns:

Snaps the popup to an even position in a horizontal grid.

getSnapY

public int getSnapY()

Returns:

Snaps the popup to an even position in a vertical grid.

isSticky

public boolean isSticky()

Returns:

Makes the popup stick around until closed.

getToolTipTextColor

public nextapp.echo.Color getToolTipTextColor()

Returns:

Color of the text inside the box.

getToolTipTextFont

public nextapp.echo.Font getToolTipTextFont()

Returns:

Font of the text inside the box

getTimeout

public int getTimeout()

Returns:

millisecs after popup go away

getPopupVerticalAlignment

public int getPopupVerticalAlignment()

Makes the popups go above the mouse.

Returns:

EchoConstants.TOP, EchoConstants.BOTTOM (default)

isVerticalAutoPositionEnabled

public boolean isVerticalAutoPositionEnabled()

Returns:

Automatically determine if the popup should be to the above or below of the mouse.

getWidth

public int getWidth()

Returns:

width of the box to some other size

getBrowserStatusBarText

public java.lang.String getBrowserStatusBarText()

Returns:

text in the browsers status bar to text.

getToolTipText

public java.lang.String getToolTipText()

Returns:

text to display in popup

getCaptionText

public java.lang.String getCaptionText()

Returns:

caption text of popup

getBorderImage

public nextapp.echo.ImageReference getBorderImage()

Returns:

picture to use instead of color for the border of the popup.

getInsideImage

public nextapp.echo.ImageReference getInsideImage()

Returns:

picture to use instead of color for the inside of the popup.

isHoverable

public boolean isHoverable()

Returns:

behaviour of popup hoverable (default) or clickable

isCssSupport

public boolean isCssSupport()

Returns:

CSS support for Fonts enabled

setPopupHorizontalAlignment

public void setPopupHorizontalAlignment(int newValue)

Makes the popups go to the left of the mouse

Parameters:

newValue - - horizontal alignment ( EchoConstants.LEFT | EchoConstants.RIGHT (default) | EchoConstants.CENTER )

setAutoStatus

public void setAutoStatus(boolean newValue)

Sets the status bar's text to the popup's text. Overrides AUTOSTATUS and STATUS.

Parameters:

newValue - - toggle whether browser statusbar text is set to text

setAutoStatusCaption

public void setAutoStatusCaption(boolean newValue)

Sets the status bar's text to the popup's caption. Overrides AUTOSTATUS and STATUS.

Parameters:

newValue - - toggle whether browser statusbar text is set to caption

setBackgroundImage

public void setBackgroundImage(nextapp.echo.ImageReference newValue)

Instead of using the table box as background, your picture will be used.

Parameters:

newValue - - border image

setBorderColor

public void setBorderColor(nextapp.echo.Color newValue)

Color of the border of the popup box.

Parameters:

newValue - - border color

setBorderSize

public void setBorderSize(int newValue)

Makes the border of the popups thicker or thinner.

Parameters:

newValue - - bordersize

setCaptionColor

public void setCaptionColor(nextapp.echo.Color newValue)

Sets the color of the box's caption.

Parameters:

newValue - - Caption color

setCaptionIcon

public void setCaptionIcon(nextapp.echo.ImageReference newValue)

Displays a small icon before the popup caption.

Parameters:

newValue - - Caption icon

setCaptionFont

public void setCaptionFont(nextapp.echo.Font newValue)

Sets the font of the caption.

Parameters:

newValue - - Caption font

setForceCloseEnabled

public void setForceCloseEnabled(boolean newValue)

Force users to click on "Close" to close sticky popups. This command toggles the feature on and off. You have to set STICKY true and CAPTION to non-null value also

Parameters:

newValue - - toggle whether user has to click on "Close" to close sticky popups

setCloseColor

public void setCloseColor(nextapp.echo.Color newValue)

Sets the color of the "Close" text.

Parameters:

newValue - - color for "Close" text

setCloseFont

public void setCloseFont(nextapp.echo.Font newValue)

Defines the font for the "Close" text. Sticky has to be enabled to show any effect.

Parameters:

newValue - - font for "Close" text

setCloseText

public void setCloseText(java.lang.String newValue)

Replaces the text "Close" with something else. Sticky has to be enabled to show any effect.

Parameters:

newValue - - text for "Close"

setDelay

public void setDelay(int milliseconds)

Makes that popup behave like a tooltip. It will popup only after a certain delay specified in millisecs. Set this to -1 if you want the popup to be displayed immediately.

Parameters:

milliseconds - - millisec after popup appears

setInsideColor

public void setInsideColor(nextapp.echo.Color newValue)

Color of the inside of the popup box.

Parameters:

newValue - - Color of the inside of the popup box.

setFixX

public void setFixX(int x)

Locks the popups horizontal position. Overrides all other horizontal placement.

Parameters:

x - - horizontal position

setFixY

public void setFixY(int y)

Locks the popups vertical position. Overrides all other vertical placement.

Parameters:

y - - vertical position

setFullHtmlEnabled

public void setFullHtmlEnabled(boolean newValue)

Allows you to control the html over a BACKGROUND picture completely. The html code is expected in "text"

Parameters:

newValue - - toggle whether text should be rendered as HTML

setHorizontalAutoPositionEnabled

public void setHorizontalAutoPositionEnabled(boolean newValue)

Automatically determine if the popup should be to the left or right of the mouse. This command toggles the feature on or off.

Parameters:

newValue - - toggle automatic adjustment of popup left or right the mouse.

setHeight

public void setHeight(int newValue)

Sets the height of the box.

Parameters:

newValue - - height of the box.

setNoCloseText

public void setNoCloseText(boolean newValue)

Doesn't display the text "Close" on stickies with caption.

Parameters:

newValue - - toggle whether display the text "Close" on stickies with caption.

setOffsetX

public void setOffsetX(int newValue)

How far away from the pointer the popup will show up, horizontally.

Parameters:

newValue - - horizontal offset

setOffsetY

public void setOffsetY(int newValue)

How far away from the pointer the popup will show up, vertically.

Parameters:

newValue - - vertical offset

setPadX

public void setPadX(int left,
                    int right)

Pads the background picture with horizontal whitespace for text placement.

Parameters:

left - - horizontal whitespace for text placement.

right - - horizontal whitespace for text placement.

setPadY

public void setPadY(int bottom,
                    int top)

Pads the background picture with vertical whitespace for text placement.

Parameters:

bottom - - vertical whitespace for text placement.

top - - vertical whitespace for text placement.

setSnapX

public void setSnapX(int newValue)

Snaps the popup to an even position in a horizontal grid.

Parameters:

newValue - - even position in horizontal grid.

setSnapY

public void setSnapY(int newValue)

Snaps the popup to an even position in a vertical grid.

Parameters:

newValue - - even position in vertical grid.

setSticky

public void setSticky(boolean newValue)

Makes the popup stick around until closed.

Parameters:

newValue - - toggle whether popup stick around until closed.

setToolTipTextColor

public void setToolTipTextColor(nextapp.echo.Color newValue)

Sets the color of the text inside the box.

Parameters:

newValue - - color of the text inside the box.

setToolTipTextFont

public void setToolTipTextFont(nextapp.echo.Font newValue)

Sets the font of the text inside the box

Parameters:

newValue - - font of the text inside the box

setTimeout

public void setTimeout(int milliseconds)

Makes the popup go away after the requested delay.

Parameters:

milliseconds - - millisec after popup goes away

setPopupVerticalAlignment

public void setPopupVerticalAlignment(int newValue)

Makes the popups go above/below the mouse.

Parameters:

newValue - - EchoConstants.TOP, EchoConstants.BOTTOM (default)

setVerticalAutoPositionEnabled

public void setVerticalAutoPositionEnabled(boolean newValue)

Automatically determine if the popup should be to the above or below of the mouse. This command toggles the feature on or off.

Parameters:

newValue - - toggle automatic adjustment of popup above or below the mouse.

setWidth

public void setWidth(int newValue)

Sets the width of the box to some other size

Parameters:

newValue - - width of the box

setBrowserStatusBarText

public void setBrowserStatusBarText(java.lang.String newValue)

Sets the text in the browsers status bar to text. original called STATUS

Parameters:

newValue - - text in the browsers status bar

setToolTipText

public void setToolTipText(java.lang.String newValue)

text to display in popup

Parameters:

newValue - - text to display in popup

setCaptionText

public void setCaptionText(java.lang.String newValue)

caption text of popup

Parameters:

newValue - - caption text of popup

setBorderImage

public void setBorderImage(nextapp.echo.ImageReference newValue)

Defines a picture to use instead of color for the border of the popup. You will most likely want to set BorderColor to null or the color will show as well. When having a Close link, Netscape will re-render the table cells, making things look bad.

Parameters:

newValue - - a picture to use instead of color for the inside of the popup.

setInsideImage

public void setInsideImage(nextapp.echo.ImageReference newValue)

Defines a picture to use instead of color for the inside of the popup. You will most likely want to set InsideColor to null or the color will show as well.

Parameters:

newValue - - a picture to use instead of color for the inside of the popup.

setHoverable

public void setHoverable(boolean newValue)

toggle popup behaviour between to hoverable (default) and clickable

Parameters:

newValue - - true = hoverable, false = clickable

setCssSupport

public void setCssSupport(boolean newValue)

toggle CSS support for fonts. If enabled no insideImage is supported

Parameters:

newValue - - toggle CSS support

isComplexRendering

public boolean isComplexRendering()

Controls whether the ToolTipPopUp will be rendered for using all the complex behaviour or whether it will default back to the client browser default from previous versions.

Returns:

true or false

setComplexRendering

public void setComplexRendering(boolean newRendering)

Controls whether the ToolTipPopUp will be rendered for using all the complex behaviour or whether it will default back to the client browser default from previous versions.

set

public java.lang.Object set(java.lang.reflect.Field field,
                            java.lang.Object newValue)
                     throws java.lang.Exception

Description copied from interface: ReflectionSetter

Called to save the old value of a field, set in a new value and return the old value of a field. This interface allows a field set operation to be "delegated" back into the class that has permission to perform the field set.

 public Object set(Field f, Object newValue) throws Exception {
      Object oldValue = f.get(this);
      f.set(this,newValue);
      return oldValue;
 }
 

Specified by:

set in interface ReflectionSetter

Overrides:

set in class DevNull

Throws:

java.lang.Exception

See Also:

ReflectionSetter.set(Field, Object)