echopoint.asynch
Class AsynchContentPane

java.lang.Object
  nextapp.echo.AbstractComponent
      nextapp.echo.AbstractPane
          nextapp.echo.ContentPane
              echopoint.asynch.AsynchContentPane

All Implemented Interfaces:

AsynchEventSink, java.io.Serializable, Component

public class AsynchContentPane
extends ContentPane
implements AsynchEventSink

AsynchContentPane is a ContentPane pane that can receive asynchronous communications events, because it implements AsynchEventSink.

Components that are added to the ContentPane can implement the special client side support code and receive asynchonous event notifications.

See Also:

Serialized Form

Field Summary

Fields inherited from class nextapp.echo.ContentPane

BACKGROUND_IMAGE_PROPERTIES_CHANGED_PROPERTY, DEFAULT_INSETS, HEIGHT_CHANGED_PROPERTY, HEIGHT_EXTENT_CHANGED_PROPERTY, HORIZONTAL_ALIGNMENT_CHANGED_PROPERTY, INSETS_CHANGED_PROPERTY, SCROLL_BAR_ALWAYS, SCROLL_BAR_AUTO, SCROLL_BAR_NEVER, SCROLL_BAR_POLICY_CHANGED_PROPERTY, SCROLL_BAR_X_CHANGED_PROPERTY, SCROLL_BAR_Y_CHANGED_PROPERTY, STYLE_BACKGROUND_IMAGE, STYLE_BACKGROUND_IMAGE_PROPERTIES, STYLE_HEIGHT, STYLE_HEIGHT_EXTENT, STYLE_HORIZONTAL_ALIGNMENT, STYLE_INSETS, STYLE_SCROLL_BAR_POLICY, STYLE_VERTICAL_ALIGNMENT, STYLE_WIDTH, STYLE_WIDTH_EXTENT, VERTICAL_ALIGNMENT_CHANGED_PROPERTY, WIDTH_CHANGED_PROPERTY, WIDTH_EXTENT_CHANGED_PROPERTY

Fields inherited from class nextapp.echo.AbstractPane

PROPORTIONAL, RESIZABLE_CHANGED_PROPERTY, STYLE_RESIZABLE

Fields inherited from interface nextapp.echo.Component

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

Constructor Summary

AsynchContentPane()

Method Summary

void	add(Component c, int n) If the component that is added, supports AsynchEventSource, then this pane is set as its AsynchEventSink.
AsynchEvent	getEvent() Returns the next event in the sink, waiting forever till one is available.
AsynchEvent	getEvent(long waitTime) Returns the next event in the sink, waiting for waitTime.
boolean	putEvent(AsynchEvent asynchEvent) Puts an event into the sink, waiting forever until there is room to place the event..
boolean	putEvent(AsynchEvent asynchEvent, int waitTime) Puts an event into the sink, waiting up to waitTime until there is room to place the event.
void	remove(Component c) If the component that is removed, supports AsynchEventSource, then its AsynchEventSink is set to null.

Methods inherited from class nextapp.echo.ContentPane

addCssFile, applyStyle, getBackgroundImage, getBackgroundImageProperties, getCssFiles, getHeightExtent, getHorizontalAlignment, getInsets, getScrollBarPolicy, getScrollBarX, getScrollBarY, getVerticalAlignment, getWidthExtent, isCssStyled, isScrollBarPositionModified, setBackgroundImage, setBackgroundImageProperties, setCssStyled, setHeight, setHeightExtent, setHorizontalAlignment, setInsets, setScrollBarPolicy, setScrollBarPositionModified, setScrollBarX, setScrollBarY, setVerticalAlignment, setWidth, setWidthExtent

Methods inherited from class nextapp.echo.AbstractPane

getHeight, getWidth, isResizable, setResizable

Methods inherited from class nextapp.echo.AbstractComponent

add, addHierarchyListener, addPropertyChangeListener, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getClientId, getComponent, getComponentCount, getComponents, getEchoInstance, getFont, getForeground, getIdentifier, getListenerList, getLocale, getParent, indexOf, init, isAncestorOf, isDifferent, isEnabled, isFocused, isRecursivelyVisible, isRegistered, isSelectableForScriptRecorder, isShowing, isVisible, processHierarchyEvent, remove, removeAll, removeHierarchyListener, removePropertyChangeListener, setBackground, setClientId, setEnabled, setFocused, setFont, setForeground, setIdentifier, setLocale, setParent, setRegistered, setSelectableForScriptRecorder, setVisible, update, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

AsynchContentPane

public AsynchContentPane()

Method Detail

getEvent

public AsynchEvent getEvent()
                     throws java.lang.InterruptedException

Description copied from interface: AsynchEventSink

Returns the next event in the sink, waiting forever till one is available.

Specified by:

getEvent in interface AsynchEventSink

Returns:

an AsynchEvent

Throws:

java.lang.InterruptedException

See Also:

AsynchEventSink.getEvent()

getEvent

public AsynchEvent getEvent(long waitTime)
                     throws java.lang.InterruptedException

Description copied from interface: AsynchEventSink

Returns the next event in the sink, waiting for waitTime.

Specified by:

getEvent in interface AsynchEventSink

Parameters:

waitTime - - how long to wait for an event

Returns:

an AsynchEvent or null if there is no available in the time frame

Throws:

java.lang.InterruptedException

See Also:

AsynchEventSink.getEvent(long)

putEvent

public boolean putEvent(AsynchEvent asynchEvent)
                 throws java.lang.InterruptedException

Description copied from interface: AsynchEventSink

Puts an event into the sink, waiting forever until there is room to place the event..

Specified by:

putEvent in interface AsynchEventSink

Parameters:

asynchEvent - - the event to place in the sink

Returns:

true if the event could be placed in the sink

Throws:

java.lang.InterruptedException

See Also:

AsynchEventSink.putEvent(echopoint.asynch.AsynchEvent)

putEvent

public boolean putEvent(AsynchEvent asynchEvent,
                        int waitTime)
                 throws java.lang.InterruptedException

Description copied from interface: AsynchEventSink

Puts an event into the sink, waiting up to waitTime until there is room to place the event.

Specified by:

putEvent in interface AsynchEventSink

Parameters:

asynchEvent - - the event to place in the sink

waitTime - - how long to wait for room in the sink or - 1 to wait for ever

Returns:

true if the event could be placed in the sink or false if there is no room after the specified waitTime.

Throws:

java.lang.InterruptedException

See Also:

AsynchEventSink.putEvent(echopoint.asynch.AsynchEvent, int)

add

public void add(Component c,
                int n)

If the component that is added, supports AsynchEventSource, then this pane is set as its AsynchEventSink.

Specified by:

add in interface Component

Overrides:

add in class AbstractComponent

Parameters:

c - The child component to add.

n - The index at which to add the child component, or -1 to add the component at the end.

See Also:

Component.add(nextapp.echo.Component, int)

remove

public void remove(Component c)

If the component that is removed, supports AsynchEventSource, then its AsynchEventSink is set to null.

Specified by:

remove in interface Component

Overrides:

remove in class AbstractComponent

Parameters:

c - The child component to remove.

See Also:

Component.remove(nextapp.echo.Component)