com.guiseframework.platform.web
Interface WebComponentDepictor<C extends Component>

Type Parameters:

C - The type of component being depicted.

All Superinterfaces:

ComponentDepictor<C>, Depictor<C>, WebDepictor<C>

All Known Implementing Classes:

AbstractDecoratedWebComponentDepictor, AbstractSimpleWebComponentDepictor, AbstractWebActionControlDepictor, AbstractWebComponentDepictor, AbstractWebFrameDepictor, AbstractWebLayoutComponentDepictor, AbstractWebMenuDepictor, WebAccordionMenuDepictor, WebApplicationFrameDepictor, WebButtonDepictor, WebCardPanelDepictor, WebCheckControlDepictor, WebCustomButtonDepictor, WebDropMenuDepictor, WebFieldsetDepictor, WebFileInputDepictor, WebFlashDepictor, WebFrameDepictor, WebHeadingDepictor, WebHeadingLinkDepictor, WebImageActionControlDepictor, WebImageBooleanSelectActionControlViewer, WebImageDepictor, WebLabelDepictor, WebLabelPanelDepictor, WebLayoutComponentDepictor, WebLinkDepictor, WebListDepictor, WebMessageDepictor, WebPanelDepictor, WebPictureDepictor, WebResourceCollectDepictor, WebScrollControlDepictor, WebSelectableLabelDepictor, WebSelectDepictor, WebSelectLinkDepictor, WebSliderDepictor, WebTabbedPanelDepictor, WebTabDepictor, WebTableDepictor, WebTextBoxDepictor, WebTextControlDepictor, WebToolButtonDepictor, WebTreeControlDepictor, WebValueSelectLinkDepictor

public interface WebComponentDepictor<C extends Component>
extends ComponentDepictor<C>, WebDepictor<C>

A strategy for depicting components on the web platform. All component depictors on the web platform must implement this interface.

Author:

Garret Wilson

Field Summary

Fields inherited from interface com.guiseframework.platform.Depictor

GENERAL_PROPERTY

Method Summary

java.lang.String

getDepictName() Determines the identifier to place in the name attribute of the component's XHTML element, if appropriate.

Methods inherited from interface com.guiseframework.platform.web.WebDepictor

getDepictContext, getPlatform

Methods inherited from interface com.guiseframework.platform.Depictor

depict, getDepictedObject, getSession, installed, isDepicted, processEvent, setDepicted, uninstalled

Method Detail

getDepictName

java.lang.String getDepictName()

Determines the identifier to place in the name attribute of the component's XHTML element, if appropriate. This is usually the string version of the ID of the component, but some grouped components may use a common name.

Returns:

An identifier appropriate for the name attribute of the component's XHTML element.