Class FormComponent

Superclass for all form components

picon\Component implements picon\InjectOnWakeup, picon\Identifiable, picon\Detachable

picon\MarkupContainer

picon\LabeledMarkupContainer

picon\FormComponent

Direct known subclasses

picon\AbstractChoice, picon\AbstractTextComponent, picon\Button, picon\CheckBox, picon\CheckBoxGroup, picon\FileUploadField, picon\FormComponentPanel, picon\RadioGroup

Indirect known subclasses

picon\AbstractMultipleChoice, picon\AbstractSingleChoice, picon\TextArea, picon\TextField, picon\AjaxButton, picon\CheckChoice, picon\DateField, picon\DropDown, picon\ListMultiple, picon\PasswordField, picon\RadioChoice, picon\RequiredTextField

Abstract
Namespace: picon
Package: web\markup\html\form
Author: Martin Cassidy
Located at web/markup/html/form/FormComponent.php

Methods summary
`public`	# `add( mixed & $object )` Add a new validator, child component or behavior to the component Add a new validator, child component or behavior to the component Parameters `$object` `mixed` Overrides `picon\MarkupContainer::add`
`public`	# `addValidator( picon\Validator & $validator )` Add a new validator to the component Add a new validator to the component Parameters `$validator` `picon\Validator`
`public type`	# `getLabel( )` Returns `type` Todo
`protected`	# `onComponentTag( picon\ComponentTag $tag )` This is called imediatly before the tag is written to the output This method allows direct manipulation of the object representing the actual markup element that is to be rendered. This is called imediatly before the tag is written to the output This method allows direct manipulation of the object representing the actual markup element that is to be rendered. When overriding this method you must remember to call the super. Parameters `$tag` `picon\ComponentTag` The tag being rendered Overrides `picon\Component::onComponentTag`
`public picon\Form`	# `getForm( )` Find the form in which this component is located Find the form in which this component is located Returns `picon\Form` The form to which this component belongs
`public string`	# `getRawInput( )` Returns `string` The raw input from the request
`public array`	# `getRawInputArray( )` Returns `array`
`public boolean`	# `validate( )` Returns `boolean`
`public`	# `updateModel( )` Update the model object of the form component with the new object value. Update the model object of the form component with the new object value. This should only be called after the conponent has been validated. Do not call this method unless you know what you are doing!
`final public`	# `processInput( )` Complete a full form component process: validate, if valid update the model Complete a full form component process: validate, if valid update the model
`abstract protected`	# `convertInput( )` Convert the input from its raw format the that which is expected Sub classes which need to handle this themselves should override this method and have getType() throw UnsupportedOperationException Convert the input from its raw format the that which is expected Sub classes which need to handle this themselves should override this method and have getType() throw UnsupportedOperationException
`public`	# `isValid( )`
`public`	# `setRequired( boolean $required )` Parameters `$required` `boolean`
`public`	# `isRequired( )`
`public`	# `validateRequired( )`
`public`	# `getConvertedInput( )`
`protected`	# `setConvertedInput( $convertedInput )`
`public`	# `getName( )`
`public`	# `inputChanged( )` Called by Form when the form input has changed Called by Form when the form input has changed
`public`	# `getValue( )`
`public`	# `invalid( )`
`public`	# `valid( )`
`public`	# `isEmptyInput( )`
`abstract protected`	# `validateModel( )`
`public`	# `beforeComponentRender( )` Called just before a component is rendered Called just before a component is rendered Overrides `picon\Component::beforeComponentRender`
`public`	# `setDisabled( $disabled )`
`public`	# `isMultiPart( )`

Methods inherited from picon\MarkupContainer
`addComponent(), addOrReplace(), afterPageRender(), beforePageRender(), childExists(), detach(), get(), getChildren(), getMarkupForChild(), hasChildren(), internalInitialize(), loadAssociatedMarkup(), onComponentAdded(), onComponentTagBody(), onRender(), remove(), visitChildren()`

Methods inherited from picon\Component
__construct(), addBehaviour(), afterComponentRender(), checkComponentTag(), checkComponentTagAttribute(), error(), fatel(), fireInitialize(), generateUrlFor(), getApplication(), getBehaviourById(), getBehaviours(), getComponentKey(), getComponentPath(), getId(), getIdentifier(), getLocalizer(), getMarkUpSource(), getMarkup(), getMarkupId(), getModel(), getModelObject(), getModelObjectAsString(), getPage(), getParent(), getRequest(), getRequestCycle(), getResponse(), hasErrorMessage(), hasMessage(), info(), internalRenderComponent(), isAuto(), isBeforePageRender(), isInitialized(), isRendered(), isStateless(), newMarkupSource(), onInitialize(), render(), renderAll(), renderElement(), renderHead(), renderHeadContainer(), setAfterComponentRenderCallback(), setAfterPageRenderCallback(), setBeforeComponentRenderCallback(), setBeforePageRenderCallback(), setMarkup(), setMarkupId(), setModel(), setModelObject(), setOnComponentTagBodyCallback(), setOnComponentTagCallback(), setOutputMarkupId(), setPage(), setParent(), setRenderBodyOnly(), setRenderHeadCallback(), setVisible(), success(), urlForListener(), urlForPage(), urlForPageInstance(), visitParents(), warning()

Constants inherited from picon\Component
`PATH_SEPERATOR, TYPE_ARRAY, TYPE_BOOL, TYPE_DOUBLE, TYPE_FLOAT, TYPE_INT, TYPE_STRING, VISITOR_CONTINUE_TRAVERSAL, VISITOR_CONTINUE_TRAVERSAL_NO_DEEPER, VISITOR_STOP_TRAVERSAL`

Properties inherited from picon\Component
`$added`

Namespaces

Classes

Interfaces

Exceptions

Class FormComponent

Direct known subclasses

Indirect known subclasses

Parameters

Overrides

Parameters

Returns

Todo

Parameters

Overrides

Returns

Returns

Returns

Returns

Parameters

Overrides