Class RecordView

Abstract Class for rendering the Form view and Detail View Some things are awkward from being retroactivly applied. STRUCTURE: With a given form layout:

RenderMain (getMainOptions) RenderSections (getSectionOptions) RenderSectionTitle RenderRows (getRowOptions) RenderColumns (getColumnOptions) RenderItems (getItemOptions) RenderLabel RenderAttribute

The get<part>Options() function return an array of html options for that section. This makes it easier to override classes you want to add on specific elements

CComponent

CBaseController

CWidget

X2Widget

RecordView

Direct known subclasses

DetailView, FormView

Abstract
Located at x2engine/protected/components/RecordView.php

Methods summary
`abstract public string`	# `renderAttribute( array $item, Fields $field )` Renders the Attribute of a form item. For a View, this is the value of the field. For a Form, this is the inpute of the field Renders the Attribute of a form item. For a View, this is the value of the field. For a Form, this is the inpute of the field Parameters `$item` `array` $item array of item settings `$field` `Field` $field field object being rendered Returns `string` HTML to add to the form
`abstract public array`	# `getLayoutData( )` Gets the layout of the form. Gets the layout of the form. Returns `array` Array of the form layout
`public`	# `setFormSettings( array $formSettings )`
`public`	# `init( )` Inititialization Inititialization Overrides `X2Widget::init()`
`public`	# `run( )` Executes the widget. This method is called by CBaseController::endWidget. Executes the widget. This method is called by CBaseController::endWidget. Overrides `CWidget::run()`
`public`	# `getPackages( )`
`public`	# `getJSClassParams( )`
`public array`	# `getMainOptions( )` HtmlOptions for the main tag that wraps the form HtmlOptions for the main tag that wraps the form Returns `array` HTML Attributes
`public array`	# `getSectionOptions( mixed $section, mixed $collapsed )` HtmlOptions for the .formSection tags HtmlOptions for the .formSection tags Returns `array` HTML Attributes
`public array`	# `getRowOptions( mixed $row )` HtmlOptions for the .formSectionRow tags HtmlOptions for the .formSectionRow tags Returns `array` HTML Attributes
`public array`	# `getColumnOptions( mixed $col, mixed $count )` HtmlOptions for the .formSectionColumn tags HtmlOptions for the .formSectionColumn tags Returns `array` HTML Attributes
`public array`	# `getItemOptions( mixed $item, Fields $field )` HtmlOptions for the .formItem tags HtmlOptions for the .formItem tags Returns `array` HTML Attributes
`public string`	# `renderMain( )` Renders the upper level tag and all sections Renders the upper level tag and all sections Returns `string` HTML
`protected`	# `renderSections( )`
`public string`	# `renderSection( mixed $section, mixed $collapsed )` Renders the tag for all sections and renders the interior rows Renders the tag for all sections and renders the interior rows Returns `string` HTML
`public`	# `renderSectionHeader( array $section )` Renders a section header Renders a section header Parameters `$section` `array` $section Section Options
`public`	# `renderRow( mixed $row )` Renders a .formSectionRow and interior columns Renders a .formSectionRow and interior columns
`public`	# `renderColumn( array $col, integer $count )` Renders .formSectionColumn and interior Items Note that this is a table Renders .formSectionColumn and interior Items Note that this is a table Parameters `$col` `array` $col Layout options for columns `$count` `integer` $count count of columns in this row
`public`	# `renderItem( mixed $item )`
`public`	# `renderNoneLabel( mixed $item, Fields $field )` Renders the None Label type. Omits the label and increases colspan to to 2 Renders the None Label type. Omits the label and increases colspan to to 2
`public`	# `renderInlineLabel( mixed $item, Fields $field )` See `RecordView::renderNoneLabel()`
`public [type]`	# `renderTopLabel( [type] $item, Fields $field )` Renders the top label type. Renders the label in it's own row, increases colspan to 2 Renders the top label type. Renders the label in it's own row, increases colspan to 2 Parameters `$item` `[type]` $item [description] `$field` `[type]` $field [description] Returns `[type]` [description]
`public`	# `renderLeftLabel( mixed $item, Fields $field )` Renders the most common label, LeftLabel Renders the most common label, LeftLabel
`public`	# `renderLabel( mixed $field )` Renders the label of a field Renders the label of a field
`public array`	# `getFieldPermissions( )` Gets the field Permissions into an aray Gets the field Permissions into an aray Returns `array` array of field permissions
`public array`	# `getFields( )` Retrieves all Fields for this model Retrieves all Fields for this model Returns `array` array of Fields objects
`public`	# `canEdit( Fields $field )` Returns if the form or a specific field can be edited. If Field is empty, it returns permissions of whole form Returns if the form or a specific field can be edited. If Field is empty, it returns permissions of whole form
`public`	# `canView( mixed $field )`

Methods inherited from X2Widget
`__construct(), ajaxRender(), behaviors(), getModule(), renderFile(), setModule()`

Methods inherited from CWidget
`actions(), getController(), getId(), getOwner(), getViewFile(), getViewPath(), render(), setId()`

Methods inherited from CBaseController
`beginCache(), beginClip(), beginContent(), beginWidget(), createWidget(), endCache(), endClip(), endContent(), endWidget(), renderInternal(), widget()`

Methods inherited from CComponent
`__call(), __get(), __isset(), __set(), __unset(), asa(), attachBehavior(), attachBehaviors(), attachEventHandler(), canGetProperty(), canSetProperty(), detachBehavior(), detachBehaviors(), detachEventHandler(), disableBehavior(), disableBehaviors(), enableBehavior(), enableBehaviors(), evaluateExpression(), getEventHandlers(), hasEvent(), hasEventHandler(), hasProperty(), raiseEvent()`

Properties summary
`public array`	`$htmlOptions`	`array ( 'class' => 'x2-layout-island' )`	# $htmlOptions $htmlOptions
`public string`	`$JSClass`	`'RecordView'`	# JS Class JS Class
`public string`	`$modelName`		# Model Name of the record being displayed Model Name of the record being displayed
`public [type]`	`$model`		# Model obejct of the record being displayed Model obejct of the record being displayed
`public string`	`$scenario`	`'Default'`	# Scenario of the form. options: Default, Inline Scenario of the form. options: Default, Inline
`public array`	`$suppressFields`	`array()`	# Fields to hide from the form Fields to hide from the form
`public array`	`$specialFields`	`array()`	# Special fields to render within the view Special fields to render within the view
`public array`	`$layoutData`		# The parsed JSON created from the form layout editor The parsed JSON created from the form layout editor
`protected array`	`$_formSettings`		# The form settings that contains the saved collapsed sections The form settings that contains the saved collapsed sections
`protected array`	`$_fieldPermissions`		# Array of field permissions Array of field permissions
`protected array`	`$_fields`		# Array of fields objects to extract settings from Array of fields objects to extract settings from

Properties inherited from X2Widget
`$_module`

Properties inherited from CWidget
`$actionPrefix, $skin`

Magic properties inherited from X2Widget
`$module`

Magic properties inherited from CWidget
`$controller, $id, $owner, $viewPath`

Packages

Classes

Interfaces

Exceptions

Functions

Class RecordView

Direct known subclasses

Parameters

Returns

Returns

Overrides

Overrides

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Parameters

Parameters

See

Parameters

Returns

Returns

Returns