com.sapportals.admin.wizardframework.components

Class CheckboxChoiceComponent

java.lang.Object
  com.sapportals.admin.wizardframework.components.AbstractWizardComponent
      com.sapportals.admin.wizardframework.components.AbstractInputComponent
          com.sapportals.admin.wizardframework.components.CheckboxChoiceComponent

All Implemented Interfaces:

IDependencyObject, IWizardComponent

Deprecated. Use Admin Studio Wizard Framework, as described in Creating Administration Interfaces (Web Dynpro) on the Help Portal documentation (help.sap.com).

public class CheckboxChoiceComponent
extends AbstractInputComponent

The class that represents a checkbox input component.

Field Summary

Fields inherited from class com.sapportals.admin.wizardframework.components.AbstractInputComponent

captionWidth, DEFAULT_PADDING, defaultCaption, defaultTooltip, filledIncompletely, INPUT_COMPONENT, inputComponent, label, layout, padding, VALUE, valueTargetPath

Fields inherited from class com.sapportals.admin.wizardframework.components.AbstractWizardComponent

HORIZONTAL_LAYOUT, VERTICAL_LAYOUT

Constructor Summary

CheckboxChoiceComponent()
Deprecated. A blank constructor.

CheckboxChoiceComponent(String caption)
Deprecated. A constructor that sets a caption.

CheckboxChoiceComponent(String caption, boolean iDefaultValue)
Deprecated. A constructor that sets a caption and whether to use a default value.

CheckboxChoiceComponent(String caption, boolean iDefaultValue, int iLayout, int iPadding)
Deprecated. A constructor that sets a caption, whether to use a default value, a layout and padding.

Method Summary

protected com.sapportals.htmlb.Component	createInputComponent(IBasicEditingContext context) Deprecated. Creates a checkbox component.
com.sapportals.htmlb.Checkbox	getCheckboxComponent(IBasicEditingContext context) Deprecated. use getInputComponent(com.sapportals.admin.wizardframework.api.IBasicEditingContext)
com.sapportals.htmlb.Checkbox	getInputComponent(IBasicEditingContext context) Deprecated. Gets the checkbox component.
boolean	getSelected(IBasicEditingContext context) Deprecated. use getValue(com.sapportals.admin.wizardframework.api.IWizardContext)
boolean	getValue(IWizardContext context) Deprecated. Gets the value from a checkbox component.
void	processInput(IWizardContext context) Deprecated. Saves to the data model the values entered into wizard controls by the administrator.
void	setLayout(int iLayout) Deprecated. Sets a layout for the checkbox component.
void	setSelected(boolean selected, IWizardContext context) Deprecated. use setValue(boolean, com.sapportals.admin.wizardframework.api.IWizardContext)
void	setValue(boolean selected, IWizardContext context) Deprecated. Sets a value for the checkbox component.

Methods inherited from class com.sapportals.admin.wizardframework.components.AbstractInputComponent

clear, clearIfInconsistent, getCaption, getCaptionComponent, getDisplay, getErrorMessages, getInputComponentGeneric, getMissingFieldErrorMessage, getTooltip, getValueGeneric, isComplete, setCaption, setCaptionWidth, setCustomErrorMessage, setPath, setTooltip, setupComponent, setValueGeneric, setValueTargetPath

Methods inherited from class com.sapportals.admin.wizardframework.components.AbstractWizardComponent

doAfterSubmit, doBeforeDisplay, getControlInFocus, getDescription, getPath, getProperty, getTitle, init, isInitialized, isMandatory, setMandatory, setProperty, setTempProperty, wasChanged

Methods inherited from class java.lang.Object

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

Constructor Detail

CheckboxChoiceComponent

public CheckboxChoiceComponent()

Deprecated.

A blank constructor. The caption and default selection must be set at runtime.

CheckboxChoiceComponent

public CheckboxChoiceComponent(String caption)

Deprecated.

A constructor that sets a caption.

Parameters:

caption - a caption

CheckboxChoiceComponent

public CheckboxChoiceComponent(String caption,
                               boolean iDefaultValue)

Deprecated.

A constructor that sets a caption and whether to use a default value.

Parameters:

caption - a caption

iDefaultValue - true uses a default value, false does not

CheckboxChoiceComponent

public CheckboxChoiceComponent(String caption,
                               boolean iDefaultValue,
                               int iLayout,
                               int iPadding)

Deprecated.

A constructor that sets a caption, whether to use a default value, a layout and padding.

Parameters:

caption - a caption

iDefaultValue - true uses a default value, false does not

iLayout - a layout

iPadding - padding

Method Detail

setSelected

public void setSelected(boolean selected,
                        IWizardContext context)

Deprecated. use setValue(boolean, com.sapportals.admin.wizardframework.api.IWizardContext)

Sets a checkbox to be selected.

setValue

public void setValue(boolean selected,
                     IWizardContext context)

Deprecated.

Sets a value for the checkbox component.

Parameters:

selected - true if the checkbox is selected, false if not selected

context - the current wizard context

setLayout

public void setLayout(int iLayout)

Deprecated.

Sets a layout for the checkbox component.

Overrides:

setLayout in class AbstractInputComponent

Parameters:

iLayout - a layout

getSelected

public boolean getSelected(IBasicEditingContext context)

Deprecated. use getValue(com.sapportals.admin.wizardframework.api.IWizardContext)

Gets the selected checkbox.

Parameters:

context - the current editing context

getValue

public boolean getValue(IWizardContext context)

Deprecated.

Gets the value from a checkbox component.

Parameters:

context - the current wizard context

Returns:

true if the checkbox is selected, false if not selected

getCheckboxComponent

public com.sapportals.htmlb.Checkbox getCheckboxComponent(IBasicEditingContext context)

Deprecated. use getInputComponent(com.sapportals.admin.wizardframework.api.IBasicEditingContext)

Gets the checkbox component.

Parameters:

context - the current editing context

Returns:

the checkbox component

getInputComponent

public com.sapportals.htmlb.Checkbox getInputComponent(IBasicEditingContext context)

Deprecated.

Gets the checkbox component.

Parameters:

context - the current editing context

Returns:

the checkbox component

createInputComponent

protected com.sapportals.htmlb.Component createInputComponent(IBasicEditingContext context)

Deprecated.

Creates a checkbox component.

Specified by:

createInputComponent in class AbstractInputComponent

Parameters:

context - the current editing context

Returns:

a checkbox component

processInput

public void processInput(IWizardContext context)

Deprecated.

Saves to the data model the values entered into wizard controls by the administrator. The default implementation calls the pane�s myProcessInput method, and then calls processInput on all the wizard components within the pane.
Implement this method to save to the data model the data from any HTMLB controls that you created in the pane.
This method is called after a user clicks a toolbar button, causing a new request to be made to the wizard component.

Specified by:

processInput in interface IWizardComponent

Specified by:

processInput in class AbstractInputComponent

Parameters:

context - the current wizard context

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] EP-RUNTIME	[sap.com] com.sap.portal.admin.wizardframeworkdeprecated	api	EP-PIN-APF
[sap.com] EP-RUNTIME	[sap.com] tc/ep/admin/api	api	EP-PIN
[sap.com] EP-RUNTIME	[sap.com] com.sap.portal.admin.wizardframeworkdeprecated	-	EP-PIN-APF