echopoint
Class InfoWindow

java.lang.Object
  nextapp.echo.app.Component
      echopoint.InfoWindow

All Implemented Interfaces:

Serializable, RenderIdSupport

public class InfoWindow
extends Component

A component that displays a floating information window when hovering over a driver text. The driver text and optionally text surrounding the driver text are displayed in this component, while the floating information window is displayed or hidden as the user hovers over or moves out of the driver text.

The following shows sample use of this component.

   import echopoint.InfoWindow;

     ...
     final InfoWindow infoWindow = new InfoWindow();
     infoWindow.setTitle( "Note!" );
     infoWindow.setContent( "My floating ino window" );
     infoWindow.setText( "Hover over me" );
     ...
     container.add( infoWindow ); // container is any appropriate container component.
 

Version:

$Id: InfoWindow.java 74 2008-10-26 00:14:00Z sptrakesh $

Author:

Rakesh 2008-10-24

See Also:

Serialized Form

Field Summary

static String	PROPERTY_ALIGNMENT The alignment for the content text in the info window.
static String	PROPERTY_CONTENT The content to display in the info window.
static String	PROPERTY_INSETS The insets to apply for the content within the info window.
static String	PROPERTY_OTHER_TEXT_BACKGROUND The background for the pre/postfix text.
static String	PROPERTY_OTHER_TEXT_FONT The font to use for the pre/postfix text.
static String	PROPERTY_OTHER_TEXT_FOREGROUND The foreground for the pre/postfix text.
static String	PROPERTY_OTHER_TEXT_INSETS The insets for the pre/postfix text.
static String	PROPERTY_POSTFIX Optional postfix text after the text that drives the display of the info window.
static String	PROPERTY_PREFIX Optional prefix text before the text that drives the display of the info window.
static String	PROPERTY_TEXT The text that drives the display of the info window.
static String	PROPERTY_TEXT_BACKGROUND The background for the driver text.
static String	PROPERTY_TEXT_FONT The font to use for the driver text.
static String	PROPERTY_TEXT_FOREGROUND The foreground for the driver text.
static String	PROPERTY_TEXT_INSETS The insets for the driver text.
static String	PROPERTY_TITLE The title to display for the info window.
static String	PROPERTY_TITLE_ALIGNMENT The alignment to use for the title.
static String	PROPERTY_TITLE_BACKGROUND The background for the title.
static String	PROPERTY_TITLE_FONT The font to use for the title.
static String	PROPERTY_TITLE_FOREGROUND The foreground for the title.
static String	PROPERTY_TITLE_INSETS The insets for the title.
static String	PROPERTY_WIDTH The width of the info window.

Fields inherited from class nextapp.echo.app.Component

CHILD_VISIBLE_CHANGED_PROPERTY, CHILDREN_CHANGED_PROPERTY, ENABLED_CHANGED_PROPERTY, FOCUS_NEXT_ID_CHANGED_PROPERTY, FOCUS_PREVIOUS_ID_CHANGED_PROPERTY, LAYOUT_DIRECTION_CHANGED_PROPERTY, LOCALE_CHANGED_PROPERTY, PROPERTY_BACKGROUND, PROPERTY_FONT, PROPERTY_FOREGROUND, PROPERTY_LAYOUT_DATA, STYLE_CHANGED_PROPERTY, STYLE_NAME_CHANGED_PROPERTY, VISIBLE_CHANGED_PROPERTY

Constructor Summary

InfoWindow()

Method Summary

Alignment	getAlignment() Return the value of the PROPERTY_ALIGNMENT property.
String	getContent() Return the value of the PROPERTY_CONTENT property.
Insets	getInsets() Return the value of the PROPERTY_INSETS property.
Color	getOtherTextBackground() Return the value of the PROPERTY_OTHER_TEXT_BACKGROUND property.
Font	getOtherTextFont() Return the value of the PROPERTY_OTHER_TEXT_FONT property.
Color	getOtherTextForeground() Return the value of the PROPERTY_OTHER_TEXT_FOREGROUND property.
Insets	getOtherTextInsets() Return the value of the PROPERTY_OTHER_TEXT_INSETS property.
String	getPostfix() Return the value of the PROPERTY_POSTFIX property.
String	getPrefix() Return the value of the PROPERTY_PREFIX property.
String	getText() Return the value of the PROPERTY_TEXT property.
Color	getTextBackground() Return the value of the PROPERTY_TEXT_BACKGROUND property.
Font	getTextFont() Return the value of the PROPERTY_TEXT_FONT property.
Color	getTextForeground() Return the value of the PROPERTY_TEXT_FOREGROUND property.
Insets	getTextInsets() Return the value of the PROPERTY_TEXT_INSETS property.
String	getTitle() Return the value of the PROPERTY_TITLE property.
Alignment	getTitleAlignment() Return the value of the PROPERTY_TITLE_ALIGNMENT property.
Color	getTitleBackground() Return the value of the PROPERTY_TITLE_BACKGROUND property.
Font	getTitleFont() Return the value of the PROPERTY_TITLE_FONT property.
Color	getTitleForeground() Return the value of the PROPERTY_TITLE_FOREGROUND property.
Insets	getTitleInsets() Return the value of the PROPERTY_TITLE_INSETS property.
Extent	getWidth() Return the value of the PROPERTY_WIDTH property.
void	setAlignment(Alignment alignment) Set the value of the PROPERTY_ALIGNMENT property.
void	setContent(String content) Set the value of the PROPERTY_CONTENT property.
void	setInsets(Insets insets) Set the value of the PROPERTY_INSETS property.
void	setOtherTextBackground(Color textBackground) Set the value of the PROPERTY_OTHER_TEXT_BACKGROUND property.
void	setOtherTextFont(Font textFont) Set the value of the PROPERTY_OTHER_TEXT_FONT property.
void	setOtherTextForeground(Color textForeground) Set the value of the PROPERTY_OTHER_TEXT_FOREGROUND property.
void	setOtherTextInsets(Insets textInsets) Set the value of the PROPERTY_OTHER_TEXT_INSETS property.
void	setPostfix(String postfix) Set the value of the PROPERTY_POSTFIX property.
void	setPrefix(String prefix) Set the value of the PROPERTY_PREFIX property.
void	setText(String text) Set the value of the PROPERTY_TEXT property.
void	setTextBackground(Color textBackground) Set the value of the PROPERTY_TEXT_BACKGROUND property.
void	setTextFont(Font textFont) Set the value of the PROPERTY_TEXT_FONT property.
void	setTextForeground(Color textForeground) Set the value of the PROPERTY_TEXT_FOREGROUND property.
void	setTextInsets(Insets textInsets) Set the value of the PROPERTY_TEXT_INSETS property.
void	setTitle(String title) Set the value of the PROPERTY_TITLE property.
void	setTitleAlignment(Alignment titleAlignment) Set the value of the PROPERTY_TITLE_ALIGNMENT property.
void	setTitleBackground(Color titleBackground) Set the value of the PROPERTY_TITLE_BACKGROUND property.
void	setTitleFont(Font titleFont) Set the value of the PROPERTY_TITLE_FONT property.
void	setTitleForeground(Color titleForeground) Set the value of the PROPERTY_TITLE_FOREGROUND property.
void	setTitleInsets(Insets titleInsets) Set the value of the PROPERTY_TITLE_INSETS property.
void	setWidth(Extent width) Set the value of the PROPERTY_WIDTH property.

Methods inherited from class nextapp.echo.app.Component

add, add, addPropertyChangeListener, addPropertyChangeListener, dispose, firePropertyChange, get, getApplicationInstance, getBackground, getComponent, getComponent, getComponentCount, getComponents, getEventListenerList, getFocusNextId, getFocusPreviousId, getFont, getForeground, getId, getIndex, getLayoutData, getLayoutDirection, getLocale, getLocalStyle, getParent, getRenderId, getRenderIndexedProperty, getRenderIndexedProperty, getRenderLocale, getRenderProperty, getRenderProperty, getStyle, getStyleName, getVisibleComponent, getVisibleComponentCount, getVisibleComponents, hasEventListenerList, indexOf, init, isAncestorOf, isEnabled, isFocusTraversalParticipant, isRegistered, isRenderEnabled, isRenderVisible, isValidChild, isValidParent, isVisible, processInput, remove, remove, removeAll, removePropertyChangeListener, removePropertyChangeListener, set, setBackground, setComponents, setEnabled, setFocusNextId, setFocusPreviousId, setFocusTraversalParticipant, setFont, setForeground, setId, setIndex, setLayoutData, setLayoutDirection, setLocale, setRenderId, setStyle, setStyleName, setVisible, validate, verifyInput, visibleIndexOf

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTY_PREFIX

public static final String PROPERTY_PREFIX

Optional prefix text before the text that drives the display of the info window. The content should be plain text without any markup. This property may be styled.

See Also:

Constant Field Values

PROPERTY_POSTFIX

public static final String PROPERTY_POSTFIX

Optional postfix text after the text that drives the display of the info window. The content should be plain text without any markup. This property may be styled.

See Also:

Constant Field Values

PROPERTY_TEXT

public static final String PROPERTY_TEXT

The text that drives the display of the info window. Hovering over the text will display the info window. This property may be styled.

See Also:

Constant Field Values

PROPERTY_TEXT_FONT

public static final String PROPERTY_TEXT_FONT

The font to use for the driver text. This is best styled.

See Also:

Constant Field Values

PROPERTY_TEXT_FOREGROUND

public static final String PROPERTY_TEXT_FOREGROUND

The foreground for the driver text. This is best styled.

See Also:

Constant Field Values

PROPERTY_TEXT_BACKGROUND

public static final String PROPERTY_TEXT_BACKGROUND

The background for the driver text. This is best styled.

See Also:

Constant Field Values

PROPERTY_TEXT_INSETS

public static final String PROPERTY_TEXT_INSETS

The insets for the driver text. This is best styled.

See Also:

Constant Field Values

PROPERTY_OTHER_TEXT_FONT

public static final String PROPERTY_OTHER_TEXT_FONT

The font to use for the pre/postfix text. This is best styled.

See Also:

Constant Field Values

PROPERTY_OTHER_TEXT_FOREGROUND

public static final String PROPERTY_OTHER_TEXT_FOREGROUND

The foreground for the pre/postfix text. This is best styled.

See Also:

Constant Field Values

PROPERTY_OTHER_TEXT_BACKGROUND

public static final String PROPERTY_OTHER_TEXT_BACKGROUND

The background for the pre/postfix text. This is best styled.

See Also:

Constant Field Values

PROPERTY_OTHER_TEXT_INSETS

public static final String PROPERTY_OTHER_TEXT_INSETS

The insets for the pre/postfix text. This is best styled.

See Also:

Constant Field Values

PROPERTY_TITLE

public static final String PROPERTY_TITLE

The title to display for the info window. Specify this only if you want a default title bar component. The text may contain HTML markup.

See Also:

Constant Field Values

PROPERTY_TITLE_ALIGNMENT

public static final String PROPERTY_TITLE_ALIGNMENT

The alignment to use for the title. This is best styled.

See Also:

Constant Field Values

PROPERTY_TITLE_FONT

public static final String PROPERTY_TITLE_FONT

The font to use for the title. This is best styled.

See Also:

Constant Field Values

PROPERTY_TITLE_FOREGROUND

public static final String PROPERTY_TITLE_FOREGROUND

The foreground for the title. This is best styled.

See Also:

Constant Field Values

PROPERTY_TITLE_BACKGROUND

public static final String PROPERTY_TITLE_BACKGROUND

The background for the title. This is best styled.

See Also:

Constant Field Values

PROPERTY_TITLE_INSETS

public static final String PROPERTY_TITLE_INSETS

The insets for the title. This is best styled.

See Also:

Constant Field Values

PROPERTY_CONTENT

public static final String PROPERTY_CONTENT

The content to display in the info window. Specify this only if you want a default content area. The text may contain HTML markup.

See Also:

Constant Field Values

PROPERTY_ALIGNMENT

public static final String PROPERTY_ALIGNMENT

The alignment for the content text in the info window.

See Also:

Constant Field Values

PROPERTY_INSETS

public static final String PROPERTY_INSETS

The insets to apply for the content within the info window.

See Also:

Constant Field Values

PROPERTY_WIDTH

public static final String PROPERTY_WIDTH

The width of the info window. This property is best styled.

See Also:

Constant Field Values

Constructor Detail

InfoWindow

public InfoWindow()

Method Detail

getContent

public String getContent()

Return the value of the PROPERTY_CONTENT property.

Returns:

The content to be displayed in the info window.

setContent

public void setContent(String content)

Set the value of the PROPERTY_CONTENT property.

Parameters:

content - The value to set for the property.

getTitle

public String getTitle()

Return the value of the PROPERTY_TITLE property.

Returns:

The title that drives display of the info window.

setTitle

public void setTitle(String title)

Set the value of the PROPERTY_TITLE property.

Parameters:

title - The value to set for the property.

getTitleAlignment

public Alignment getTitleAlignment()

Return the value of the PROPERTY_TITLE_ALIGNMENT property.

Returns:

The alignment to use for the title text.

setTitleAlignment

public void setTitleAlignment(Alignment titleAlignment)

Set the value of the PROPERTY_TITLE_ALIGNMENT property.

Parameters:

titleAlignment - The value to set for the property.

getTitleFont

public Font getTitleFont()

Return the value of the PROPERTY_TITLE_FONT property.

Returns:

The font to use for the title.

setTitleFont

public void setTitleFont(Font titleFont)

Set the value of the PROPERTY_TITLE_FONT property.

Parameters:

titleFont - The value to set for the property.

getTitleForeground

public Color getTitleForeground()

Return the value of the PROPERTY_TITLE_FOREGROUND property.

Returns:

The font to use for the title.

setTitleForeground

public void setTitleForeground(Color titleForeground)

Set the value of the PROPERTY_TITLE_FOREGROUND property.

Parameters:

titleForeground - The value to set for the property.

getTitleBackground

public Color getTitleBackground()

Return the value of the PROPERTY_TITLE_BACKGROUND property.

Returns:

The font to use for the title.

setTitleBackground

public void setTitleBackground(Color titleBackground)

Set the value of the PROPERTY_TITLE_BACKGROUND property.

Parameters:

titleBackground - The value to set for the property.

getTitleInsets

public Insets getTitleInsets()

Return the value of the PROPERTY_TITLE_INSETS property.

Returns:

The insets to use for the title.

setTitleInsets

public void setTitleInsets(Insets titleInsets)

Set the value of the PROPERTY_TITLE_INSETS property.

Parameters:

titleInsets - The value to set for the property.

getPrefix

public String getPrefix()

Return the value of the PROPERTY_PREFIX property.

Returns:

The optional prefix text to display before the driver text.

setPrefix

public void setPrefix(String prefix)

Set the value of the PROPERTY_PREFIX property.

Parameters:

prefix - The value to set for the property.

getPostfix

public String getPostfix()

Return the value of the PROPERTY_POSTFIX property.

Returns:

The postfix text to display after the driver text.

setPostfix

public void setPostfix(String postfix)

Set the value of the PROPERTY_POSTFIX property.

Parameters:

postfix - The value to set for the property.

getText

public String getText()

Return the value of the PROPERTY_TEXT property.

Returns:

The text that drives display of the info window.

setText

public void setText(String text)

Set the value of the PROPERTY_TEXT property.

Parameters:

text - The value to set for the property.

getTextFont

public Font getTextFont()

Return the value of the PROPERTY_TEXT_FONT property.

Returns:

The font to use for the driver text.

setTextFont

public void setTextFont(Font textFont)

Set the value of the PROPERTY_TEXT_FONT property.

Parameters:

textFont - The value to set for the property.

getTextForeground

public Color getTextForeground()

Return the value of the PROPERTY_TEXT_FOREGROUND property.

Returns:

The font to use for the driver text.

setTextForeground

public void setTextForeground(Color textForeground)

Set the value of the PROPERTY_TEXT_FOREGROUND property.

Parameters:

textForeground - The value to set for the property.

getTextBackground

public Color getTextBackground()

Return the value of the PROPERTY_TEXT_BACKGROUND property.

Returns:

The font to use for the driver text.

setTextBackground

public void setTextBackground(Color textBackground)

Set the value of the PROPERTY_TEXT_BACKGROUND property.

Parameters:

textBackground - The value to set for the property.

getTextInsets

public Insets getTextInsets()

Return the value of the PROPERTY_TEXT_INSETS property.

Returns:

The insets to use for the driver text.

setTextInsets

public void setTextInsets(Insets textInsets)

Set the value of the PROPERTY_TEXT_INSETS property.

Parameters:

textInsets - The value to set for the property.

getOtherTextFont

public Font getOtherTextFont()

Return the value of the PROPERTY_OTHER_TEXT_FONT property.

Returns:

The font to use for the pre/postfix text.

setOtherTextFont

public void setOtherTextFont(Font textFont)

Set the value of the PROPERTY_OTHER_TEXT_FONT property.

Parameters:

textFont - The value to set for the property.

getOtherTextForeground

public Color getOtherTextForeground()

Return the value of the PROPERTY_OTHER_TEXT_FOREGROUND property.

Returns:

The font to use for the pre/postfix text.

setOtherTextForeground

public void setOtherTextForeground(Color textForeground)

Set the value of the PROPERTY_OTHER_TEXT_FOREGROUND property.

Parameters:

textForeground - The value to set for the property.

getOtherTextBackground

public Color getOtherTextBackground()

Return the value of the PROPERTY_OTHER_TEXT_BACKGROUND property.

Returns:

The font to use for the pre/postfix text.

setOtherTextBackground

public void setOtherTextBackground(Color textBackground)

Set the value of the PROPERTY_OTHER_TEXT_BACKGROUND property.

Parameters:

textBackground - The value to set for the property.

getOtherTextInsets

public Insets getOtherTextInsets()

Return the value of the PROPERTY_OTHER_TEXT_INSETS property.

Returns:

The insets to use for the pre/postfix text.

setOtherTextInsets

public void setOtherTextInsets(Insets textInsets)

Set the value of the PROPERTY_OTHER_TEXT_INSETS property.

Parameters:

textInsets - The value to set for the property.

getAlignment

public Alignment getAlignment()

Return the value of the PROPERTY_ALIGNMENT property.

Returns:

The alignment to use for the content text.

setAlignment

public void setAlignment(Alignment alignment)

Set the value of the PROPERTY_ALIGNMENT property.

Parameters:

alignment - The value to set for the property.

getInsets

public Insets getInsets()

Return the value of the PROPERTY_INSETS property.

Returns:

The insets to use for the pre/postfix text.

setInsets

public void setInsets(Insets insets)

Set the value of the PROPERTY_INSETS property.

Parameters:

insets - The value to set for the property.

getWidth

public Extent getWidth()

Return the value of the PROPERTY_WIDTH property.

Returns:

The width of the info window component.

setWidth

public void setWidth(Extent width)

Set the value of the PROPERTY_WIDTH property.

Parameters:

width - The value to set for the property.