org.karora.cooee.ng
Class BalloonHelp

java.lang.Object
  org.karora.cooee.app.Component
      org.karora.cooee.ng.ComponentEx
          org.karora.cooee.ng.AbleComponent
              org.karora.cooee.ng.PopUp
                  org.karora.cooee.ng.BalloonHelp

All Implemented Interfaces:

java.io.Serializable, RenderIdSupport, AccessKeyable, Attributeable, Borderable, Delegateable, Expandable, Heightable, Insetable, MouseCursorable, Sizeable, ToolTipable, Widthable

public class BalloonHelp
extends PopUp

BalloonHelp is a PopUp component that appears like classic Balloon Help, inspired from the early Apple Macintosh.

See Also:

Serialized Form

Field Summary

static Alignment	DEFAULT_ALIGNMENT The default alignment for the floating box is right/top
static Style	DEFAULT_STYLE The default Style for the BalloonHelp
static ImageReference	DEFAULT_TOGGLE_ICON The default image used as the toggle image

Fields inherited from class org.karora.cooee.ng.PopUp

DEFAULT_TOGGLE_PRESSED_ICON, DEFAULT_TOGGLE_ROLLOVER_ICON, PROPERTY_FOCUS_COMPONENT, PROPERTY_FOCUS_ON_EXPAND, PROPERTY_POPUP, PROPERTY_POPUP_ALIGNMENT, PROPERTY_POPUP_ALWAYS_ON_TOP, PROPERTY_POPUP_BACKGROUND, PROPERTY_POPUP_BORDER, PROPERTY_POPUP_INSETS, PROPERTY_POPUP_LEFT_OFFSET, PROPERTY_POPUP_NEXT_TO_TOGGLE, PROPERTY_POPUP_ON_ROLLOVER, PROPERTY_POPUP_OUTSETS, PROPERTY_POPUP_TOP_OFFSET, PROPERTY_ROLLOVER_BACKGROUND, PROPERTY_ROLLOVER_BORDER, PROPERTY_ROLLOVER_ENABLED, PROPERTY_TARGET, PROPERTY_TARGET_BACKGROUND, PROPERTY_TARGET_BORDER, PROPERTY_TARGET_INSETS, PROPERTY_TARGET_ROLLOVER_BACKGROUND, PROPERTY_TARGET_ROLLOVER_BORDER, PROPERTY_TOGGLE_BACKGROUND, PROPERTY_TOGGLE_BORDER, PROPERTY_TOGGLE_ICON, PROPERTY_TOGGLE_INSETS, PROPERTY_TOGGLE_PRESSED_BACKGROUND, PROPERTY_TOGGLE_PRESSED_BORDER, PROPERTY_TOGGLE_PRESSED_ENABLED, PROPERTY_TOGGLE_PRESSED_ICON, PROPERTY_TOGGLE_ROLLOVER_BACKGROUND, PROPERTY_TOGGLE_ROLLOVER_BORDER, PROPERTY_TOGGLE_ROLLOVER_ICON

Fields inherited from class org.karora.cooee.ng.ComponentEx

PROPERTY_HIDDEN

Fields inherited from class org.karora.cooee.app.Component

CHILDREN_CHANGED_PROPERTY, ENABLED_CHANGED_PROPERTY, FOCUS_TRAVERSAL_INDEX_CHANGED_PROPERTY, FOCUS_TRAVERSAL_PARTICIPANT_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

Fields inherited from interface org.karora.cooee.ng.able.Expandable

EXPANDED_CHANGED_PROPERTY, PROPERTY_EXPANSION_GROUP, PROPERTY_EXPANSION_MODEL

Fields inherited from interface org.karora.cooee.ng.able.AccessKeyable

PROPERTY_ACCESS_KEY

Fields inherited from interface org.karora.cooee.ng.able.Borderable

PROPERTY_BORDER

Fields inherited from interface org.karora.cooee.ng.able.MouseCursorable

CURSOR_AUTO, CURSOR_CROSSHAIR, CURSOR_CUSTOM_URI, CURSOR_DEFAULT, CURSOR_E_RESIZE, CURSOR_HELP, CURSOR_MOVE, CURSOR_N_RESIZE, CURSOR_NE_RESIZE, CURSOR_NW_RESIZE, CURSOR_POINTER, CURSOR_S_RESIZE, CURSOR_SE_RESIZE, CURSOR_SW_RESIZE, CURSOR_TEXT, CURSOR_W_RESIZE, CURSOR_WAIT, PROPERTY_MOUSE_CURSOR, PROPERTY_MOUSE_CURSOR_URI

Fields inherited from interface org.karora.cooee.ng.able.Insetable

DEFAULT_INSETS, DEFAULT_OUTSETS, PROPERTY_INSETS, PROPERTY_OUTSETS

Fields inherited from interface org.karora.cooee.ng.able.Widthable

PROPERTY_WIDTH

Fields inherited from interface org.karora.cooee.ng.able.Heightable

PROPERTY_HEIGHT

Fields inherited from interface org.karora.cooee.ng.able.ToolTipable

PROPERTY_TOOL_TIP_TEXT

Constructor Summary

BalloonHelp()
Constructs a BalloonHelp

BalloonHelp(Component popUpComponent)
Constructs a BalloonHelp with the specified popupComponent as help.

BalloonHelp(Component targetComponent, Component popUpComponent)
Constructs a BalloonHelp with the specified target and popup component

BalloonHelp(java.lang.String xhtmlText)
Constructs a BalloonHelp using the XHTML passed in as the help text.

Method Summary

Methods inherited from class org.karora.cooee.ng.PopUp

getExpansionGroup, getExpansionModel, getPopUp, getPopUpAlignment, getPopUpAlwaysOnTop, getPopUpBackground, getPopUpBorder, getPopUpInsets, getPopUpLeftOffset, getPopUpOutsets, getPopUpTopOffset, getRolloverBackground, getRolloverBorder, getTarget, getTargetBackground, getTargetBorder, getTargetInsets, getTargetRolloverBackground, getTargetRolloverBorder, getToggleBackground, getToggleBorder, getToggleIcon, getToggleInsets, getTogglePressedBackground, getTogglePressedBorder, getTogglePressedIcon, getToggleRolloverBackground, getToggleRolloverBorder, getToggleRolloverIcon, isExpanded, isPopUpNextToToggle, isPopUpOnRollover, isRolloverEnabled, isTogglePressedEnabled, processInput, setExpanded, setExpansionGroup, setExpansionModel, setFocusComponent, setFocusOnExpand, setPopUp, setPopUpAlignment, setPopUpAlwaysOnTop, setPopUpBackground, setPopUpBorder, setPopUpInsets, setPopUpLeftOffset, setPopUpNextToToggle, setPopUpOnRollover, setPopUpOutsets, setPopUpTopOffset, setRolloverBackground, setRolloverBorder, setRolloverEnabled, setTarget, setTargetBackground, setTargetBorder, setTargetInsets, setTargetRolloverBackground, setTargetRolloverBorder, setToggleBackground, setToggleBorder, setToggleIcon, setToggleInsets, setTogglePressedBackground, setTogglePressedBorder, setTogglePressedEnabled, setTogglePressedIcon, setToggleRolloverBackground, setToggleRolloverBorder, setToggleRolloverIcon, validate

Methods inherited from class org.karora.cooee.ng.AbleComponent

getAccessKey, getBorder, getHeight, getInsets, getMouseCursor, getMouseCursorUri, getOutsets, getToolTipText, getWidth, setAccessKey, setBorder, setHeight, setInsets, setMouseCursor, setMouseCursorUri, setOutsets, setToolTipText, setWidth

Methods inherited from class org.karora.cooee.ng.ComponentEx

getAttribute, getAttributeNames, getProperty, getProperty, getProperty, getProperty, getProperty, getProperty, getProperty, getProperty, getProperty, getProperty, getProperty, getProperty, getProperty, getProperty, getProperty, getProperty, getProperty, getRenderProperty, getRenderProperty, getRenderProperty, getRenderProperty, getRenderProperty, getRenderProperty, getRenderProperty, getRenderProperty, getRenderProperty, getRenderProperty, getRenderProperty, getRenderProperty, getRenderProperty, getRenderProperty, getRenderProperty, getRenderProperty, getRenderProperty, getRenderProperty, isHidden, setAttribute, setHidden, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty

Methods inherited from class org.karora.cooee.app.Component

add, add, addPropertyChangeListener, dispose, firePropertyChange, getApplicationInstance, getBackground, getComponent, getComponent, getComponentCount, getComponents, getEventListenerList, getFocusTraversalIndex, getFont, getForeground, getId, getIndexedProperty, getLayoutData, getLayoutDirection, getLocale, getParent, getProperty, getRenderId, getRenderIndexedProperty, getRenderIndexedProperty, getRenderLayoutDirection, getRenderLocale, getRenderProperty, getRenderProperty, getStyle, getStyleName, getVisibleComponent, getVisibleComponentCount, getVisibleComponents, hasEventListenerList, indexOf, init, isAncestorOf, isEnabled, isFocusTraversalParticipant, isRegistered, isRenderEnabled, isRenderVisible, isValidChild, isValidParent, isVisible, remove, remove, removeAll, removePropertyChangeListener, setBackground, setEnabled, setFocusTraversalIndex, setFocusTraversalParticipant, setFont, setForeground, setId, setIndexedProperty, setLayoutData, setLayoutDirection, setLocale, setProperty, setRenderId, setStyle, setStyleName, setVisible, verifyInput, visibleIndexOf

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.karora.cooee.ng.able.Delegateable

getRenderProperty, getRenderProperty

Methods inherited from interface org.karora.cooee.ng.able.Delegateable

getRenderProperty, getRenderProperty

Methods inherited from interface org.karora.cooee.ng.able.Delegateable

getRenderProperty, getRenderProperty

Methods inherited from interface org.karora.cooee.ng.able.Delegateable

getRenderProperty, getRenderProperty

Methods inherited from interface org.karora.cooee.ng.able.Delegateable

getRenderProperty, getRenderProperty

Methods inherited from interface org.karora.cooee.ng.able.Delegateable

getRenderProperty, getRenderProperty

Field Detail

DEFAULT_ALIGNMENT

public static final Alignment DEFAULT_ALIGNMENT

The default alignment for the floating box is right/top

DEFAULT_TOGGLE_ICON

public static final ImageReference DEFAULT_TOGGLE_ICON

The default image used as the toggle image

DEFAULT_STYLE

public static final Style DEFAULT_STYLE

The default Style for the BalloonHelp

Constructor Detail

BalloonHelp

public BalloonHelp()

Constructs a BalloonHelp

BalloonHelp

public BalloonHelp(java.lang.String xhtmlText)

Constructs a BalloonHelp using the XHTML passed in as the help text.

Parameters:

xhtmlText - - must be a fragment of valid XHTML. eg single top level tag and all tags propertly closed.

BalloonHelp

public BalloonHelp(Component popUpComponent)

Constructs a BalloonHelp with the specified popupComponent as help.

Parameters:

popUpComponent -

BalloonHelp

public BalloonHelp(Component targetComponent,
                   Component popUpComponent)

Constructs a BalloonHelp with the specified target and popup component

Parameters:

targetComponent -

popUpComponent -