org.apache.tapestry.internal
Interface Component

All Known Implementing Classes:

AbstractComponent, AbstractFormComponent, AbstractFormWidget, AbstractLinkComponent, AbstractPage, AbstractPostfield, AbstractTableRowComponent, AbstractTableViewComponent, AbstractWidget, AjaxStatus, Any, Autocompleter, BaseComponent, BasePage, Block, Body, Button, Card, Checkbox, CheckboxGroup, Choose, Conditional, ControlCheckbox, ControlledCheckbox, DateField, DatePicker, Deck, Delegator, Describe, Dialog, DirectLink, Do, DropdownDatePicker, DropdownTimePicker, DumpObject, ElseBean, Exception, ExceptionDisplay, ExternalLink, FieldLabel, ForBean, Form, FormConditional, FormTable, Frame, GenericLink, Go, GTimePicker, Hidden, IfBean, Image, Image, ImageSubmit, InlineEditBox, Input, Insert, InsertText, Inspector, InspectorButton, InvokeListener, LinkSubmit, ListEdit, MaskEdit, MultiplePropertySelection, NumericField, OnEvent, Option, Option, PageLink, Palette, Postfield, PropertySelection, PropertySelection, Radio, RadioGroup, Relation, RenderBlock, RenderBody, RequestDisplay, Rollover, Script, ScriptIncludes, Select, Select, SelectionField, Selector, ServiceLink, Setvar, Shell, ShowEngine, ShowProperties, ShowSpecification, ShowTemplate, SimpleTableColumnComponent, SimpleTableColumnFormComponent, SimpleTableColumnSortImage, SimpleTableColumnSortLink, StaleLink, Style, Submit, Suggest, Table, TableColumns, TableFormPages, TableFormRows, TablePages, TableRows, TableValues, TableView, TextArea, TextField, Timeout, Timer, Tree, TreeDataView, TreeNodeView, TreeTable, TreeTableDataView, TreeTableNodeViewDelegator, TreeView, Upload, ValidatingTextField, ValidField, ViewTabs, When, WMLException, WMLStaleLink, XTile

public interface Component

Represents the internal component api exposed for use by core framework code only.

Use at your own risk as everything in this API is subject to change without notice from release to release.

Method Summary

IRender[]	getContainedRenderers() Returns the list of of IRender elements contained by this component.
IRender[]	getInnerRenderers() In some rare cases a component has both outer and inner renderers - such as with BaseComponent.
boolean	hasEvents() Checks if this component has been targeted / connected to for client side event listening via @EventListener.
void	setHasEvents(boolean hasEvents) Sets whether or not this component has events.

Method Detail

getContainedRenderers

IRender[] getContainedRenderers()

Returns the list of of IRender elements contained by this component. Ie whatever has been added via IComponent.addBody(IRender).

Returns:

The values, if any. Null otherwise.

getInnerRenderers

IRender[] getInnerRenderers()

In some rare cases a component has both outer and inner renderers - such as with BaseComponent. This value should return the normal inner renderers most components do in those instances while the other getContainedRenderers() should return the outer renderers.

Returns:

The inner renderers if this component supports more than one type, null otherwise.

hasEvents

boolean hasEvents()

Checks if this component has been targeted / connected to for client side event listening via @EventListener.

Returns:

True if anything has targeted this component, false otherwise.

setHasEvents

void setHasEvents(boolean hasEvents)

Sets whether or not this component has events.

Parameters:

hasEvents - Whether or not this component has connected events.