org.cruxframework.crux.core.rebind.screen

Class View

java.lang.Object

org.cruxframework.crux.core.rebind.screen.View

public class View
extends Object

Represents a Crux View at the application's server side. Used for GWT Generators.

Author:

Thiago Bustamante

Field Summary

Fields

Modifier and Type	Field and Description
protected List<String>	controllers
protected String	dataObject
protected List<String>	dataSources Deprecated.
protected boolean	disableRefresh
protected Map<String,Event>	events
protected List<String>	formatters
protected String	fragment
protected String	height
protected String	id
protected String	largeViewport
protected List<String>	resources
protected List<String>	serializers Deprecated.
protected String	smallViewport
protected String	title
protected List<String>	views
protected Map<String,Widget>	widgets
protected Set<String>	widgetTypes
protected String	width

Constructor Summary

Constructors

Constructor and Description
View(String id, JSONArray elements, JSONObject lazyDependencies, String html, boolean rootView)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addController(String controller) Import a controller into view
protected void	addDataSource(String dataSource) Import a dataSource into view
protected void	addEvent(Event event) Add a new event to view
protected void	addFormatter(String formatter) Import a formatter into view
protected void	addResource(String resource) Import a resources into view
protected void	addSerializer(String serializer) Import a serializer for a CruxSerializable into view
protected void	addView(String view) Import a view into screen
protected void	addWidget(Widget widget) Add a new widget to view
String	getDataObject() DataObject bound to this view.
JSONArray	getElements() Return the elements metadata
Event	getEvent(String evtId) Return a event associated with the given id
ViewFactoryCreator	getFactory()
String	getFragment() Fragment name, used for code spliting
String	getHeight() Retrieve the view height
String	getHtml()
String	getId() Return view identifier
String	getLargeViewport() Viewport for large devices
JSONObject	getLazyDependencies() Return the lazy dependencies metadata
String	getSmallViewport() Viewport for small devices
String	getTitle() Return the view title
JSONObject	getViewElement()
Widget	getWidget(String widgetId) Return DeclarativeFactory associated to the given id
Set<String>	getWidgetTypesIncluded() Return a Set containing all types of widgets found on this view
String	getWidth() Retrieve the view width
boolean	isDisableRefresh()
boolean	isRootView()
Iterator<String>	iterateControllers() Iterate over view controllers
Iterator<String>	iterateDataSources() Iterate over view dataSources
Iterator<Event>	iterateEvents() Iterate over view events
Iterator<String>	iterateFormatters() Iterate over view formatters
Iterator<String>	iterateResources() Iterate over view resources
Iterator<String>	iterateSerializers() Iterate over view serializers
Iterator<String>	iterateViews() Iterate over screen views
Iterator<Widget>	iterateWidgets() Iterate over widgets
protected void	setDataObject(String dataObject) DataObject bound to this view.
protected void	setDisableRefresh(boolean disableRefresh)
void	setFactory(ViewFactoryCreator factory)
protected void	setFragment(String fragment) Fragment name, used for code spliting
void	setHeight(String height) Set the view height
protected void	setLargeViewport(String largeViewport) Viewport for large devices
protected void	setSmallViewport(String smallViewport) Viewport for small devices
void	setTitle(String title) Sets the view title
void	setWidth(String width) Set the view width
boolean	useController(String controller)
boolean	useDataSource(String datasource)
boolean	useFormatter(String formatter)
boolean	useResource(String resource)

Methods inherited from class java.lang.Object

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

Field Detail

id

protected String id

title

protected String title

width

protected String width

height

protected String height

fragment

protected String fragment

smallViewport

protected String smallViewport

largeViewport

protected String largeViewport

dataObject

protected String dataObject

disableRefresh

protected boolean disableRefresh

widgets

protected Map<String,Widget> widgets

widgetTypes

protected Set<String> widgetTypes

events

protected Map<String,Event> events

controllers

protected List<String> controllers

serializers

@Deprecated
protected List<String> serializers

Deprecated.

formatters

protected List<String> formatters

dataSources

@Deprecated
protected List<String> dataSources

Deprecated.

views

protected List<String> views

resources

protected List<String> resources

Constructor Detail

View

public View(String id,
    JSONArray elements,
    JSONObject lazyDependencies,
    String html,
    boolean rootView)

Method Detail

getWidget

public Widget getWidget(String widgetId)

Return DeclarativeFactory associated to the given id

Parameters:

widgetId -

Returns:

getWidgetTypesIncluded

public Set<String> getWidgetTypesIncluded()

Return a Set containing all types of widgets found on this view

Returns:

iterateWidgets

public Iterator<Widget> iterateWidgets()

Iterate over widgets

Returns:

getWidth

public String getWidth()

Retrieve the view width

Returns:

setWidth

public void setWidth(String width)

Set the view width

Parameters:

width -

getHeight

public String getHeight()

Retrieve the view height

Returns:

setHeight

public void setHeight(String height)

Set the view height

Parameters:

height -

addWidget

protected void addWidget(Widget widget)

Add a new widget to view

Parameters:

widget -

getId

public String getId()

Return view identifier

Returns:

addEvent

protected void addEvent(Event event)

Add a new event to view

Parameters:

event -

getEvent

public Event getEvent(String evtId)

Return a event associated with the given id

Parameters:

evtId -

Returns:

iterateEvents

public Iterator<Event> iterateEvents()

Iterate over view events

Returns:

addController

protected void addController(String controller)

Import a controller into view

Parameters:

event -

iterateControllers

public Iterator<String> iterateControllers()

Iterate over view controllers

Returns:

useController

public boolean useController(String controller)

Parameters:

controller -

Returns:

addResource

protected void addResource(String resource)

Import a resources into view

Parameters:

event -

iterateResources

public Iterator<String> iterateResources()

Iterate over view resources

Returns:

useResource

public boolean useResource(String resource)

Parameters:

resource -

Returns:

useDataSource

public boolean useDataSource(String datasource)

Parameters:

datasource -

Returns:

useFormatter

public boolean useFormatter(String formatter)

Parameters:

formatter -

Returns:

addSerializer

protected void addSerializer(String serializer)

Import a serializer for a CruxSerializable into view

Parameters:

event -

iterateSerializers

public Iterator<String> iterateSerializers()

Iterate over view serializers

Returns:

addFormatter

protected void addFormatter(String formatter)

Import a formatter into view

Parameters:

event -

iterateFormatters

public Iterator<String> iterateFormatters()

Iterate over view formatters

Returns:

addDataSource

protected void addDataSource(String dataSource)

Import a dataSource into view

Parameters:

event -

iterateDataSources

public Iterator<String> iterateDataSources()

Iterate over view dataSources

Returns:

getElements

public JSONArray getElements()

Return the elements metadata

Returns:

getLazyDependencies

public JSONObject getLazyDependencies()

Return the lazy dependencies metadata

Returns:

getFactory

public ViewFactoryCreator getFactory()

Returns:

setFactory

public void setFactory(ViewFactoryCreator factory)

Parameters:

factory -

getFragment

public String getFragment()

Fragment name, used for code spliting

Returns:

setFragment

protected void setFragment(String fragment)

Fragment name, used for code spliting

Parameters:

fragment -

getDataObject

public String getDataObject()

DataObject bound to this view.

Returns:

setDataObject

protected void setDataObject(String dataObject)

DataObject bound to this view.

Parameters:

dataObject -

getSmallViewport

public String getSmallViewport()

Viewport for small devices

Returns:

setSmallViewport

protected void setSmallViewport(String smallViewport)

Viewport for small devices

Parameters:

smallViewport -

isDisableRefresh

public boolean isDisableRefresh()

Returns:

setDisableRefresh

protected void setDisableRefresh(boolean disableRefresh)

Parameters:

disableRefresh -

getLargeViewport

public String getLargeViewport()

Viewport for large devices

Returns:

setLargeViewport

protected void setLargeViewport(String largeViewport)

Viewport for large devices

Parameters:

largeViewport -

getTitle

public String getTitle()

Return the view title

Returns:

setTitle

public void setTitle(String title)

Sets the view title

Parameters:

title -

addView

protected void addView(String view)

Import a view into screen

Parameters:

event -

iterateViews

public Iterator<String> iterateViews()

Iterate over screen views

Returns:

isRootView

public boolean isRootView()

Returns:

getHtml

public String getHtml()

Returns:

getViewElement

public JSONObject getViewElement()

Returns: