Form (HTMLB (Netweaver 2004S SPS 09))

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

SAP NetWeaver 2004S SPS 10

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.sapportals.htmlb

Class Form

java.lang.Object
  com.sapportals.htmlb.Component
      com.sapportals.htmlb.Container
          com.sapportals.htmlb.Form

public class Form
extends Container

The Form element which encapsulates all entry or event-firing controls.

Nested Class Summary
`class`	`Form.FormElement` internal class for encapsulating form meta-data

Field Summary
`static String`	`UI_ID`
`static int`	`VAR_BEGIN` constant for render call. render the begin of the form
`static int`	`VAR_END` constant for render call. render the end of the form

Fields inherited from class com.sapportals.htmlb.Container

elements

Constructor Summary
`Form()` Application developers should not use this constructor directly.
`Form(String formId)` Application developers should not use this constructor directly.

Method Summary
`void`	`addForcedEnabledElement(String generatedId, Component component)` internal use only
`void`	`addForceJavascriptInterface(IJavascriptComponent c, String generatedId)`
`void`	`addFormEndJavascript(JavascriptFragment javascript)`
`void`	`addFullIdFormElement(String componentId, String fullId)`
`void`	`addStandAloneHoverMenusAsString(StringBuffer hoverMenusAsString)`
`void`	`clearForceJavascriptInterface()`
`void`	`clearFormEndJavascripts()`
`void`	`decodeFormElements(String encodedString)` decode Form meta-data from a String representation.
`String`	`encodeFormElements()` encode all form elements in a String.
`String`	`getAction()` get the action for this form, i.e. the URL that will receive the request for this form when submitted
`Class`	`getClassForId(int index)` INTERNAL USE ONLY.
`String`	`getClassIdForComponent(String name)` INTERNAL USE ONLY.
`String`	`getClassIdForComponent(String tableName, String name)` INTERNAL USE ONLY.
`ClassLoader`	`getClassLoader()`
`Component`	`getComponentById(String id)` INTERNAL USE ONLY.
`String`	`getComponentIdForLabel(String id)` INTERNAL USE ONLY.
`IEventModifier`	`getCurrentEventModifier()`
`Button`	`getDefaultButton()` get the current default button for this page.
`String`	`getEncodingType()` get the encoding type for this form, e.g.
`ArrayList`	`getEventModifier()`
`String`	`getEventNameForId(int index)` INTERNAL USE ONLY.
`Component`	`getFocusedControl()` get the control which will get the focus after loading the page
`HashMap`	`getForcedEnabledElement()` internal use only
`TreeMap`	`getForceJavascriptInterface()`
`ArrayList`	`getFormEndJavascripts()`
`String`	`getFormId()` get the Id of this form
`String`	`getFullIdForComponent(Component component)` INTERNAL USE ONLY.
`String`	`getFullIdForComponent(String name)` INTERNAL USE ONLY.
`String`	`getFullIdForComponent(String modifierName, String name, int row)` INTERNAL USE ONLY.
`HashMap`	`getFullIdFormElements()`
`HashSet`	`getHoverMenus()` returns the hover menus for rendering
`int`	`getIdForClass(Class aClass)` INTERNAL USE ONLY.
`int`	`getIdForEvent(String eventName)` INTERNAL USE ONLY.
`int`	`getIndexOfElement(Component component)` internal use.
`int`	`getIndexOfLabel(String id)`
`String`	`getLanguage()` gets the language identification for this component.
`MessageBar`	`getMessageBar()`
`String`	`getMethod()` get the method associated with this form, either 'GET' or 'POST'
`Iterator`	`getRegisteredElementNames()` get a HashMap containing all registered elements for this form.
`HashMap`	`getRegisteredElements()` get a HashMap containing all registered elements for this form.
`HashSet`	`getScrollContainerSet()`
`StringBuffer`	`getStandAloneHoverMenusAsString()`
`String`	`getTarget()` get the target frame for this form
`String`	`getUI()` get a identification String for the renderer that is unique across all supported components.
`String`	`getUserIdForIndex(int index)` INTERNAL USE ONLY.
`HashSet`	`getValueHelpMappingFields()` returns the value help mapping fields
`boolean`	`isDiscardFocusFirstElement()`
`boolean`	`isHeightInHundredPercent()` returns if the height should be in hundert percent
`boolean`	`isLabeled(String id)`
`boolean`	`isLoadingMessage()`
`boolean`	`isMessageBarAtFormEnd()`
`boolean`	`isMessageBarRequired()` returns if a message bar is required for this form or not
`boolean`	`isScrollingToLastPosition()`
`boolean`	`isUserDefinedMessageBar()`
`boolean`	`isWidthInHundredPercent()` returns if the width of the form is hundert percent
`IEventModifier`	`popEventModifier()`
`void`	`pushEventModifier(IEventModifier eventModifier)`
`protected int`	`registerFormElement(Component component)` INTERNAL USE ONLY.
`int`	`registerFormElement(Component component, String id)` INTERNAL USE ONLY.
`void`	`registerHoverMenu(HoverMenu hoverMenu)` register the hover menu hover menus within one page should be collected before they'll be rendered, for saving performance
`void`	`registerScrollContainer(String id)`
`void`	`registerValueHelpMappingField(InputField field)` register the value help mapping fields
`void`	`setAction(String theAction)` set the action for this form, i.e. the URL that will receive the request for this form when submitted
`void`	`setClassLoader(ClassLoader classLoader)`
`void`	`setDefaultButton(Button defaultButton)` sets the current default button for this page.
`void`	`setDiscardFocusFirstElement(boolean discardFocus)` If false (default) the focus in 508 mode should go to the first possible element.
`void`	`setEncodingType(String theEncodingType)` set the encoding type for this form, e.g.
`void`	`setFocusedControl(Button focusedButton)` set the control which will get the focus after loading the page
`void`	`setFocusedControl(Component focusedComponent)` set the control which will get the focus after loading the page
`void`	`setFocusedControl(DropdownListBox focusedDropdownListBox)` set the control which will get the focus after loading the page
`void`	`setFocusedControl(InputField focusedInputField)` set the control which will get the focus after loading the page
`void`	`setFocusedControl(TextEdit focusedTextEdit)` set the control which will get the focus after loading the page
`void`	`setFormId(String theFormId)` set the Id of this form.
`void`	`setHeightInHundredPercent(boolean heightInHundredPercent)` sets the height of the form to 100%
`void`	`setLanguage(String language)` sets the language identification for this component.
`void`	`setLoadingMessage(boolean show)`
`void`	`setMessageBar(MessageBar messageBar)` sets the message bar for validation
`void`	`setMessageBarAtFormEnd(boolean messageBarAtBodyEnd)`
`void`	`setMessageBarRequired(boolean messageBarRequired)` determines if a message bar is required for this form or not
`void`	`setMethod(String theMethod)` set the method associated with this form, either 'GET' or 'POST'
`void`	`setScrollingToLastPosition(boolean scrollingToLastPosition)`
`void`	`setTarget(String target)` set the target frame for this form.
`void`	`setUserDefinedMessageBar(boolean userDefinedMessageBar)`
`void`	`setWidthInHundredPercent(boolean widthInHundredPercent)` sets the width of the form to hundert percent

Methods inherited from class com.sapportals.htmlb.Container

addComponent, addRawText, addText, getChildCount, iterator, preRender, removeComponent, render

Methods inherited from class com.sapportals.htmlb.Component

getEncodedIdForForm, getId, getParent, initFromPageContext, initFromShortId, initializeFromId, isJsObjectNeeded, render, renderAsString, requiresForm, setId, setJsObjectNeeded, setParent

Methods inherited from class java.lang.Object

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

Field Detail

UI_ID

public static final String UI_ID

See Also:: Constant Field Values

VAR_BEGIN

public static final int VAR_BEGIN

constant for render call. render the begin of the form

See Also:: Constant Field Values

VAR_END

public static final int VAR_END

constant for render call. render the end of the form

See Also:: Constant Field Values

Constructor Detail

Form

public Form()

Application developers should not use this constructor directly. Use createForm() or createFormDocument() in interface IPageContext.

convenience constructor for a new form. An ID will automatically be supplied.

Form

public Form(String formId)

Application developers should not use this constructor directly. Use createForm() or createFormDocument() in interface IPageContext.

creates a Form with a given ID.

Parameters:

formId - the Id to be used for this form. Must be 'clean' for HTML usage!

Method Detail

pushEventModifier

public void pushEventModifier(IEventModifier eventModifier)

popEventModifier

public IEventModifier popEventModifier()

getCurrentEventModifier

public IEventModifier getCurrentEventModifier()

getEventModifier

public ArrayList getEventModifier()

getUI

public String getUI()

get a identification String for the renderer that is unique across all supported components. E.g. you could simply return the class name of the component class. The reason for using a separate method and not some internal reflection method is that you can more easily extend the functionality or your Component class without having to rewrite the view class.

Specified by:: getUI in class Component

Returns:: a unique identification string for this Component

getMethod

public String getMethod()

get the method associated with this form, either 'GET' or 'POST'

Returns:: the method for this form

setMethod

public void setMethod(String theMethod)

set the method associated with this form, either 'GET' or 'POST'

Parameters:: theMethod - the method to be used

getAction

public String getAction()

get the action for this form, i.e. the URL that will receive the request for this form when submitted

Returns:: the Action for this form

setAction

public void setAction(String theAction)

set the action for this form, i.e. the URL that will receive the request for this form when submitted

Parameters:: theAction - the Action, i.e. URL for this form

getFormId

public String getFormId()

get the Id of this form

Returns:: the id

setFormId

public void setFormId(String theFormId)

set the Id of this form. You must not change any form ID while already rendering content!

Parameters:: theFormId - the id

getEncodingType

public String getEncodingType()

get the encoding type for this form, e.g. "multipart/form-data" if you want to use a file-upload button

Returns:: the encoding type for this form.

setEncodingType

public void setEncodingType(String theEncodingType)

set the encoding type for this form, e.g. "multipart/form-data" if you want to use a file-upload button

Parameters:: theEncodingType - the encoding type for this form.

getTarget

public String getTarget()

get the target frame for this form

Returns:: the target for this form

setTarget

public void setTarget(String target)

set the target frame for this form. E.g. "_blank", "_self", "_parent", "_top" or any freely chosen name.

Parameters:: target - the target for this form

getDefaultButton

public Button getDefaultButton()

get the current default button for this page. This button will be triggered if the user presses the return key in the browser.

Returns:: the default Button for this form

setDefaultButton

public void setDefaultButton(Button defaultButton)

sets the current default button for this page. This button will be triggered if the user presses the return key in the browser.

Parameters:: defaultButton - the default Button for this form

getFocusedControl

public Component getFocusedControl()

get the control which will get the focus after loading the page

Returns:: control id