echopoint
Class PopUp

java.lang.Object
  nextapp.echo.Component
      nextapp.echo.Container
          echopoint.EchoPointComponent
              echopoint.PopUp

All Implemented Interfaces:

MouseCursorable, ReflectionSetter, java.io.Serializable, ToolTipPopUpSupport, nextapp.echo.ToolTipSupport

Direct Known Subclasses:

BalloonHelp

public class PopUp

extends EchoPointComponent

The PopUp class provides an container component that can popup over other components.

The user can click on an icon image to initiate the popup.

Only one PopUp component can be active at the one time. All other popups are hidden.

You can add content to the PopUp using the usual add() methods.

See Also:

Serialized Form

Nested Class Summary

static class

PopUp.NestedStyleInfo Nested public static StyleInfo class.

Field Summary

static java.lang.String	AUTO_COLLAPSE_CHANGED_PROPERTY Auto Collapse Property
static nextapp.echo.ImageReference	defaultIcon default popup icon
static java.lang.String	EXPANSION_MODEL_CHANGED_PROPERTY Model Property
static java.lang.String	ICON_CHANGED_PROPERTY property name fired when the imageReference changes
static java.lang.String	STYLE_ICON A style constant for the Icon property.

Fields inherited from class echopoint.EchoPointComponent

STYLE_TOOL_TIP_TEXT, TOOL_TIP_TEXT_CHANGED_PROPERTY, toolTipPopUp

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

Fields inherited from interface echopoint.positionable.MouseCursorable

borderStyleSymbolics, 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, STYLE_MOUSE_CURSOR, STYLE_MOUSE_CURSOR_URI

Constructor Summary

PopUp()
Constructs a PopUp with a default popup icon.

PopUp(nextapp.echo.ImageReference imageRef)
Constructs a PopUp with the specified icon image.

Method Summary

void	applyStyle(nextapp.echo.Style style)
ExpandableModel	getExpansionModel()
nextapp.echo.ImageReference	getIcon() Returns the ImageReference within.
boolean	isAutoCollapse() Returns TRUE if the PopUp will revert to a collapsed state when any server interaction occurs.
boolean	isExpanded()
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	setAutoCollapse(boolean newAutoCollapse) Sets whether the PopUp will revert to a collapsed state when any server interaction occurs.
void	setExpanded(boolean isExpanded) Sets whether the PopUp is active or not (ie expanded).
void	setExpansionModel(ExpandableModel newExpansionModel) Sets the ExpandableModel model used by the PopUp.
void	setIcon(nextapp.echo.ImageReference newValue) Sets the ImageReference used by the PopUp

Methods inherited from class echopoint.EchoPointComponent

getMouseCursor, getMouseCursorURI, getToolTipPopUp, getToolTipText, set, set, set, set, set, set, set, set, set, setEnabledAllChildren, setMouseCursor, setMouseCursorURI, setToolTipText, validate

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, setVisible, update

Methods inherited from class java.lang.Object

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

Field Detail

AUTO_COLLAPSE_CHANGED_PROPERTY

public static final java.lang.String AUTO_COLLAPSE_CHANGED_PROPERTY

Auto Collapse Property

See Also:

Constant Field Values

defaultIcon

public static nextapp.echo.ImageReference defaultIcon

default popup icon

EXPANSION_MODEL_CHANGED_PROPERTY

public static final java.lang.String EXPANSION_MODEL_CHANGED_PROPERTY

Model Property

See Also:

Constant Field Values

ICON_CHANGED_PROPERTY

public static final java.lang.String ICON_CHANGED_PROPERTY

property name fired when the imageReference changes

See Also:

Constant Field Values

STYLE_ICON

public static final java.lang.String STYLE_ICON

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

See Also:

Constant Field Values

Constructor Detail

PopUp

public PopUp()

Constructs a PopUp with a default popup icon.

PopUp

public PopUp(nextapp.echo.ImageReference imageRef)

Constructs a PopUp with the specified icon image.

Method Detail

applyStyle

public void applyStyle(nextapp.echo.Style style)

Specified by:

applyStyle in interface MouseCursorable

Overrides:

applyStyle in class EchoPointComponent

See Also:

EchoPointComponent.applyStyle(nextapp.echo.Style)

getExpansionModel

public ExpandableModel getExpansionModel()

Returns:

the ExpandableModel model of the PopUp.

getIcon

public nextapp.echo.ImageReference getIcon()

Returns the ImageReference within.

Returns:

ImageReference - the ImageReference within.

isAutoCollapse

public boolean isAutoCollapse()

Returns TRUE if the PopUp will revert to a collapsed state when any server interaction occurs. By default this is TRUE.

Returns:

boolean

isExpanded

public boolean isExpanded()

Returns:

whether PopUp is active or not.

setAutoCollapse

public void setAutoCollapse(boolean newAutoCollapse)

Sets whether the PopUp will revert to a collapsed state when any server interaction occurs. By default this is TRUE.

Parameters:

newAutoCollapse - boolean

setExpanded

public void setExpanded(boolean isExpanded)

Sets whether the PopUp is active or not (ie expanded).

setExpansionModel

public void setExpansionModel(ExpandableModel newExpansionModel)

Sets the ExpandableModel model used by the PopUp.

setIcon

public void setIcon(nextapp.echo.ImageReference newValue)

Sets the ImageReference used by the PopUp

Parameters:

newValue -

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;
 }
 

Parameters:

field - - the field to be set

newValue - - the new value to be set

Returns:

the oldValue of the field

Throws:

java.lang.Exception

See Also:

ReflectionSetter.set(Field, Object)