com.github.bordertech.wcomponents

Interface WebComponent

All Superinterfaces:

Serializable

All Known Subinterfaces:

AccessKeyable, AjaxInternalTrigger, AjaxTarget, AjaxTrigger, Autocompleteable, AutocompleteableDate, AutocompleteableEmail, AutocompleteableMultiline, AutocompleteableNumeric, AutocompleteablePassword, AutocompleteablePhone, AutocompleteableText, AutocompleteableURL, Container, Diagnosable, DialogOpenTrigger, Disableable, DropZone, ErrorPage, Input, Labelable, Mandatable, Marginable, MenuContainer, MenuItem, MenuItemGroup, MenuItemSelectable, MenuSelectContainer, MultiInputComponent, MutableContainer, NamingContextable, Placeholderable, SubordinateTarget, SubordinateTrigger, Targetable, WComponent

All Known Implementing Classes:

AbstractContainer, AbstractInput, AbstractMutableContainer, AbstractNamingContextContainer, AbstractTransientDataContainer, AbstractWComponent, AbstractWComponent.WComponentRef, AbstractWFieldIndicator, AbstractWMultiSelectList, AbstractWSelectList, AbstractWSingleSelectList, AjaxCleanupInterceptor, AjaxDebugStructureInterceptor, AjaxErrorInterceptor, AjaxInterceptor, AjaxPageShellInterceptor, AjaxSetupInterceptor, ContextCleanupInterceptor, DataListInterceptor, DebugStructureInterceptor, DefaultTransientDataContainer, DefaultWComponent, FatalErrorPage, FormInterceptor, HeadLineInterceptor, InterceptorComponent, PageShellInterceptor, ProfileContainer, RadioButtonGroup, ResponseCacheInterceptor, SessionTokenAjaxInterceptor, SessionTokenContentInterceptor, SessionTokenInterceptor, SubordinateControlInterceptor, TargetableErrorInterceptor, TargetableInterceptor, TemplateRenderInterceptor, TransformXMLInterceptor, UIContextDumpInterceptor, UicProfileButton, ValidateXMLInterceptor, VelocityInterceptor, WAbbrText, WAjaxControl, WAjaxPollingRegion, WApplication, WAudio, WBeanComponent, WBeanContainer, WButton, WCancelButton, WCardManager, WCheckBox, WCheckBoxSelect, WCollapsible, WCollapsibleToggle, WColumn, WColumnLayout, WComponentGroup, WConfirmationButton, WContainer, WContent, WContentLink, WDataRenderer, WDataTable, WDataTableRowRenderer, WDateField, WDecoratedLabel, WDefinitionList, WDialog, WDropdown, WEditableImage, WEmailField, WField, WFieldErrorIndicator, WFieldLayout, WFieldSet, WFieldWarningIndicator, WFigure, WFileWidget, WFilterText, WHeading, WHiddenComment, WhitespaceFilterInterceptor, WHorizontalRule, WImage, WImageEditor, WInternalLink, WInvisibleContainer, WLabel, WLink, WList, WMenu, WMenuItem, WMenuItemGroup, WMessageBox, WMessages, WMultiDropdown, WMultiFileWidget, WMultiSelect, WMultiSelectPair, WMultiTextField, WNamingContext, WNumberField, WPanel, WPartialDateField, WPasswordField, WPhoneNumberField, WPopup, WPrintButton, WProgressBar, WRadioButton, WRadioButtonSelect, WRepeater, WRepeater.WRepeatRoot, WrongStepAjaxInterceptor, WrongStepContentInterceptor, WrongStepServerInterceptor, WRow, WSection, WSelectToggle, WSeparator, WShuffler, WSingleSelect, WSkipLinks, WStyledText, WSubMenu, WSubordinateControl, WSuggestions, WTab, WTabGroup, WTable, WTable.TableRepeater, WTableColumn, WTableRepeater, WTableRowRenderer, WTabSet, WTemplate, WText, WTextArea, WTextField, WTimeoutWarning, WToggleButton, WTree, WValidationErrors, WVideo, WWindow, WWindowInterceptor

public interface WebComponent
extends Serializable

The interface for web components. Internally the web components don't use this - they use WComponent. This is for use outside of the WComponent framework.

Since:

1.0.0

Author:

James Gifford

Method Summary

Modifier and Type	Method and Description
String	getId() Get a unique ID for this WebComponent.
String	getName() Deprecated. no longer used. use getId() instead.
void	paint(RenderContext renderContext) Produce xml (or other) output.
void	preparePaint(Request request) Called before the component is painted.
void	serviceRequest(Request request) Transfer data from the incoming request to the context.

Method Detail

preparePaint

void preparePaint(Request request)

Called before the component is painted.

Parameters:

request - the request being responded to.

paint

void paint(RenderContext renderContext)

Produce xml (or other) output.

Parameters:

renderContext - the RenderContext to send the output to.

getName

String getName()

Deprecated. no longer used. use getId() instead.

Returns the name of this WebComponent. The name for a WebComponent should be unique across the WComponent tree (within a single http service).

Returns:

the name of the component.

getId

String getId()

Get a unique ID for this WebComponent. The ID is guaranteed to be unique across an entire HTML page. This method should be used to generate the HTML ID attributes.

Returns:

the id of the component.

serviceRequest

void serviceRequest(Request request)

Transfer data from the incoming request to the context.

Parameters:

request - the request being serviced.