org.ofbiz.widget.screen
Class ModelScreenWidget

java.lang.Object
  org.ofbiz.widget.ModelWidget
      org.ofbiz.widget.screen.ModelScreenWidget

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

HtmlWidget, HtmlWidget.HtmlTemplate, HtmlWidget.HtmlTemplateDecorator, HtmlWidget.HtmlTemplateDecoratorSection, IterateSectionWidget, ModelScreenWidget.Container, ModelScreenWidget.Content, ModelScreenWidget.DecoratorScreen, ModelScreenWidget.DecoratorSection, ModelScreenWidget.DecoratorSectionInclude, ModelScreenWidget.Form, ModelScreenWidget.HorizontalSeparator, ModelScreenWidget.Image, ModelScreenWidget.IncludeScreen, ModelScreenWidget.Label, ModelScreenWidget.Link, ModelScreenWidget.Menu, ModelScreenWidget.PlatformSpecific, ModelScreenWidget.Screenlet, ModelScreenWidget.Section, ModelScreenWidget.SubContent, ModelScreenWidget.Tree

public abstract class ModelScreenWidget
extends ModelWidget
implements java.io.Serializable

Widget Library - Screen model class

See Also:

Serialized Form

Nested Class Summary

static class	ModelScreenWidget.Container
static class	ModelScreenWidget.Content
static class	ModelScreenWidget.DecoratorScreen
static class	ModelScreenWidget.DecoratorSection
static class	ModelScreenWidget.DecoratorSectionInclude
static class	ModelScreenWidget.Form
static class	ModelScreenWidget.FrameContainer
static class	ModelScreenWidget.FrameContainerHeader
static class	ModelScreenWidget.HorizontalSeparator
static class	ModelScreenWidget.Image
static class	ModelScreenWidget.IncludeScreen
static class	ModelScreenWidget.Label
static class	ModelScreenWidget.Link
static class	ModelScreenWidget.Menu
static class	ModelScreenWidget.PlatformSpecific
static class	ModelScreenWidget.Screenlet
static class	ModelScreenWidget.Section
static class	ModelScreenWidget.SectionsRenderer
static class	ModelScreenWidget.SubContent
static class	ModelScreenWidget.Tree

Field Summary

protected ModelScreen	modelScreen
static java.lang.String	module

Fields inherited from class org.ofbiz.widget.ModelWidget

enableBoundaryCommentsParam, enableWidgetBoundaryComments, name

Constructor Summary

ModelScreenWidget(ModelScreen modelScreen, org.w3c.dom.Element widgetElement)

Method Summary

boolean	boundaryCommentsEnabled() Returns true if boundary comments are enabled for this widget, otherwise returns false.
ModelScreen	getModelScreen()
abstract java.lang.String	rawString()
static java.util.List<ModelScreenWidget>	readSubWidgets(ModelScreen modelScreen, java.util.List<? extends org.w3c.dom.Element> subElementList)
static void	renderSubWidgetsString(java.util.List<ModelScreenWidget> subWidgets, java.lang.Appendable writer, java.util.Map<java.lang.String,java.lang.Object> context, ScreenStringRenderer screenStringRenderer)
abstract void	renderWidgetString(java.lang.Appendable writer, java.util.Map<java.lang.String,java.lang.Object> context, ScreenStringRenderer screenStringRenderer)

Methods inherited from class org.ofbiz.widget.ModelWidget

getBoundaryCommentName, getName, getPaginatorNumber, incrementPaginatorNumber, setWidgetBoundaryComments, widgetBoundaryCommentsEnabled

Methods inherited from class java.lang.Object

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

Field Detail

module

public static final java.lang.String module

modelScreen

protected ModelScreen modelScreen

Constructor Detail

ModelScreenWidget

public ModelScreenWidget(ModelScreen modelScreen,
                         org.w3c.dom.Element widgetElement)

Method Detail

renderWidgetString

public abstract void renderWidgetString(java.lang.Appendable writer,
                                        java.util.Map<java.lang.String,java.lang.Object> context,
                                        ScreenStringRenderer screenStringRenderer)
                                 throws GeneralException,
                                        java.io.IOException

Throws:

GeneralException

java.io.IOException

rawString

public abstract java.lang.String rawString()

readSubWidgets

public static java.util.List<ModelScreenWidget> readSubWidgets(ModelScreen modelScreen,
                                                               java.util.List<? extends org.w3c.dom.Element> subElementList)

renderSubWidgetsString

public static void renderSubWidgetsString(java.util.List<ModelScreenWidget> subWidgets,
                                          java.lang.Appendable writer,
                                          java.util.Map<java.lang.String,java.lang.Object> context,
                                          ScreenStringRenderer screenStringRenderer)
                                   throws GeneralException,
                                          java.io.IOException

Throws:

GeneralException

java.io.IOException

boundaryCommentsEnabled

public boolean boundaryCommentsEnabled()

Description copied from class: ModelWidget

Returns true if boundary comments are enabled for this widget, otherwise returns false.

Overrides:

boundaryCommentsEnabled in class ModelWidget

Returns:

True if boundary comments are enabled for this widget

getModelScreen

public ModelScreen getModelScreen()