nextapp.echoservlet
Interface ComponentPeer

All Known Implementing Classes:

AbstractButtonUI, AbstractComponentPeer, AbstractComponentUI, AbstractDateFieldUI, AbstractPaneUI, AbstractPropertiesFileScreen, AbstractScreen, AsyncComponentUI, AsynchContentPaneUI, BalloonHelpUI, BeepUI, BlackHoleUI, BlankScreen, BoxSectionUI, ButtonUI, CalibrationScreen, CButtonUI, ChartPanelUI, CheckBoxUI, ClientDatePickerUI, ClientSideComponentSelectorUI, ColorChooserUI, ColumnSortCriterionEditor, ColumnUI, ComboBoxUI, ComponentTypeEditor, CompoundComponent, ConfirmButtonUI, ContainerPaneUI, ContainerUI, ContentPaneUI, CSSButtonUI, CSSLabelUI, CustomComponentUI, CustomRenderingComponentUI, DateFieldUI, DatePickerUI, DevNullUI, DialogPanelUI, DownloadUI, DragWrapperUI, DropDownBoxUI, DropWrapperUI, DynaButton, DynaGrid, DynaGrid.Cell, DynaGridUI, DynaHtmlEditorUI, DynaLabel, DynaLabelUI, DynaLink, DynaSaveButton, DynaTextFieldUI, EchoPointComponentPeer, EmbeddedObjectUI, EmbeddedPaneUI, ErrorMessagesComponentUI, ExpandableSectionUI, ExternalEventMonitorUI, FilePaneUI, FillerUI, FontChooserUI, GalleryScreen, GeneralSettingsScreen, GlobalExceptionScreen, Grid, Grid.Cell, GridCellUI, GridUI, GroupBoxUI, HeapInspectorScreen, HidingSlidingPanelUI, HorizontalAlignmentEditor, HorizontalPanelUI, HourGlassUI, HtmlContainerUI, HtmlTemplatePanelUI, HttpPaneUI, ImageIconUI, ImageMapUI, JamonScreen, JavaScriptButtonUI, JavaScriptIncludeUI, JspComponentPeer, JspTemplatePanelUI, KeyActionCommandUI, LabelUI, LabelUI, ListBoxUI, ListSectionUI, LogoffScreen, MenuBarUI, MenuEditorScreen, MenuItemUI, MenuUI, MockScreen, NativeCheckBoxUI, NewsManagerScreen, NewsTickerUI, NewsTickerUI, NumberFormatFieldUI, OnLoadScriptOnceComponentUI, OptimisticLockExceptionScreen, PanelUI, PanelUI, PdfBookmarkComponentUI, PdfReportComponentUI, PersistencySettingsScreen, PickListUI, PopUpUI, PopWrapperUI, PrintRequestUI, ProgressBarUI, PushButtonUI, RadioButtonUI, RebindableCompoundComponent, RebindableCompoundComponentUI, RecallComboBoxUI, ReRunButton, RichTextAreaUI, RowUI, ScrapScreen, Screen, ScrollableBoxUI, ScrollablePanel2UI, ScrollablePanelUI, SecondLevelCacheScreen, SecuritySettingsScreen, SelectableTableUI, SelectFieldUI, SeparatorUI, SessionOverviewScreen, SortableTableUI, SpinFieldUI, StopButton, StringViewer, StyleManagerScreen, SubmitButtonUI, TabbedPaneUI, TableHeaderUI, TableUI, TaskBarUI, TextAreaUI, TextComponentUI, TextFieldUI, TextFieldUI, TimeFieldUI, TimerUI, TimerUI, TimeViewer, TitleBarUI, ToggleButtonUI, TransactionSettingsScreen, TreeUI, UnitTestScreen, UploadSelectUI, VerticalAlignmentEditor, ViewStackTraceButton, WelcomeScreen, WindowUI, WizardPaneUI

public interface ComponentPeer

Field Summary

static java.lang.String

IGNORE_PROPERTY_CHANGE

Method Summary

void	addAncillaryService(Service service) Adds an ancillary service to this ComponentPeer.
Id	generateId()
Color	getCalculatedBackground() Returns the background color in which the component will be rendered.
Font	getCalculatedFont() Returns the font in which the component will be rendered.
Color	getCalculatedForeground() Returns the foreground color in which the component will be rendered.
Component	getComponent() Returns the component that is handled by this peer.
java.lang.String	getFocusedElementId()
Id	getId() Returns the Id by which this peer is identified on the client.
InstancePeer	getInstancePeer() Returns the InstancePeer with which this peer is associated.
ComponentPeer	getParentComponentPeer() Returns the peer of the associated component's component.
ComponentPeer	getPeer(Component component) Returns the peer of the specified component.
void	redraw() Requests that the component be redrawn on the client.
void	registerAncillaryServices()
void	registered() Called when the component is registered.
void	removeAncillaryService(Service service) Removes an ancillary service from this ComponentPeer.
void	render(RenderingContext rc, Element parent) A method that should be overridden for the ComponentPeer to produce HTML output.
void	setComponent(Component c)
void	setId(Id generateId)
void	setInstancePeer(InstancePeer instancePeer)
void	unregisterAncillaryServices()
void	unregistered() Called when the component is unregistered.

Field Detail

IGNORE_PROPERTY_CHANGE

static final java.lang.String IGNORE_PROPERTY_CHANGE

See Also:

Constant Field Values

Method Detail

addAncillaryService

void addAncillaryService(Service service)

Adds an ancillary service to this ComponentPeer. Ancillary services will be registered for the life of the ComponentPeer and automatically removed when it is unregistered. An ancillary service should be used by ONLY one peer, as the peer will register and unregister it from the ServiceRegistry as required.

Parameters:

service - The ancillary service to be added.

getCalculatedBackground

Color getCalculatedBackground()

Returns the background color in which the component will be rendered. The color will be determined by examining the represented component and then its ancestors until a background color can be determined.

Returns:

The background color in which the component will be rendered.

generateId

Id generateId()

getComponent

Component getComponent()

Returns the component that is handled by this peer.

Returns:

The component that is handled by this peer.

getFocusedElementId

java.lang.String getFocusedElementId()

getCalculatedFont

Font getCalculatedFont()

Returns the font in which the component will be rendered. The font will be determined by examining the represented component and then its ancestors until a font can be determined.

Returns:

The font in which the component will be rendered.

getCalculatedForeground

Color getCalculatedForeground()

Returns the foreground color in which the component will be rendered. The color will be determined by examining the represented component and then its ancestors until a foreground color can be determined.

Returns:

The foreground color in which the component will be rendered.

getId

Id getId()

Returns the Id by which this peer is identified on the client.

Returns:

The Id by which this peer is identified on the client.

getInstancePeer

InstancePeer getInstancePeer()

Returns the InstancePeer with which this peer is associated. If the peer is unregistered, null will be returned.

Returns:

The InstancePeer with which this peer is associated.

redraw

void redraw()

Requests that the component be redrawn on the client.

removeAncillaryService

void removeAncillaryService(Service service)

Removes an ancillary service from this ComponentPeer. Ancillary services will be registered for the life of the ComponentPeer and automatically removed when it is unregistered. An ancillary service should be used by ONLY one peer, as the peer will register and unregister it from the ServiceRegistry as required.

Parameters:

service - The ancillary service to be removed.

render

void render(RenderingContext rc,
            Element parent)

A method that should be overridden for the ComponentPeer to produce HTML output.

Parameters:

rc - A rendering context provided by the Connection.

parent - The element that will contain content rendered by this ComponentPeer.

getParentComponentPeer

ComponentPeer getParentComponentPeer()

Returns the peer of the associated component's component.

Returns:

The peer of the associated component's component.

getPeer

ComponentPeer getPeer(Component component)

Returns the peer of the specified component.

Parameters:

component - The component whose peer is to be returned.

Returns:

The peer of the specified component.

registered

void registered()

Called when the component is registered. This method should be overridden if necessary.

unregistered

void unregistered()

Called when the component is unregistered. This method should be overridden if necessary.

setId

void setId(Id generateId)

setInstancePeer

void setInstancePeer(InstancePeer instancePeer)

registerAncillaryServices

void registerAncillaryServices()

unregisterAncillaryServices

void unregisterAncillaryServices()

setComponent

void setComponent(Component c)