com.sapportals.admin.wizardframework.components

Class Group

java.lang.Object
  extended by com.sapportals.admin.wizardframework.components.AbstractWizardComponent
      extended by com.sapportals.admin.wizardframework.components.FlowContainer
          extended by com.sapportals.admin.wizardframework.components.Group
All Implemented Interfaces:
IDependencyObject, IWizardComponent, IWizardComponentContainer

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

public class Group
extends FlowContainer

The class that represents a group. A group is a frame that is used to visually indicate elements that belong together.


Field Summary
 
Fields inherited from class com.sapportals.admin.wizardframework.components.FlowContainer
HORIZONTAL_LAYOUT, VERTICAL_LAYOUT
 
Constructor Summary
Group()
          Deprecated. A blank constructor.
Group(com.sapportals.htmlb.enums.GroupDesign design, String title)
          Deprecated. A constructor that sets a group title and the design to be used for rendering the group.
 
Method Summary
 void clearIfInconsistent(String changedObjectKey, IWizardContext ctx)
          Deprecated. Clears all values from the object and its subtree when the object this object depends on was changed.
 com.sapportals.htmlb.Component getDisplay(IWizardContext ctx)
          Deprecated. Gets the HTMLB component to display.
 com.sapportals.htmlb.Group getGroup(IWizardContext ctx)
          Deprecated. Gets an HTMLB group control.
 
Methods inherited from class com.sapportals.admin.wizardframework.components.FlowContainer
addComponent, addComponent, addComponent, delegateDoBeforeDisplay, delegateProcessInput, delegateSetupComponent, doAfterSubmit, doBeforeDisplay, getComponent, getControlInFocus, getErrorMessages, getPath, init, isInitialized, myDoBeforeDisplay, myProcessInput, mySetupComponent, processInput, setLayout, setPath, setupComponent, wasChanged
 
Methods inherited from class com.sapportals.admin.wizardframework.components.AbstractWizardComponent
getDescription, getProperty, getTitle, isComplete, isMandatory, setMandatory, setProperty, setTempProperty
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Group

public Group()
Deprecated. 
A blank constructor. The design and title must be set at runtime.


Group

public Group(com.sapportals.htmlb.enums.GroupDesign design,
             String title)
Deprecated. 
A constructor that sets a group title and the design to be used for rendering the group.

Parameters:
design - a design
title - a title
Method Detail

getGroup

public com.sapportals.htmlb.Group getGroup(IWizardContext ctx)
Deprecated. 
Gets an HTMLB group control.

Parameters:
ctx - the current wizard context
Returns:
the HTML group control

getDisplay

public com.sapportals.htmlb.Component getDisplay(IWizardContext ctx)
Deprecated. 
Gets the HTMLB component to display. If your component has a display it should inherit AbstractDisplayComponent or AbstractInputComponent. The default implementation returns null.

Specified by:
getDisplay in interface IWizardComponent
Overrides:
getDisplay in class FlowContainer
Parameters:
ctx - the current wizard context
Returns:
the component, null if the component has no display

clearIfInconsistent

public void clearIfInconsistent(String changedObjectKey,
                                IWizardContext ctx)
Deprecated. 
Clears all values from the object and its subtree when the object this object depends on was changed.
The default implementation clears all values from the component's branch in the session.

Specified by:
clearIfInconsistent in interface IDependencyObject
Overrides:
clearIfInconsistent in class FlowContainer
Parameters:
changedObjectKey - a changed object
ctx - the current wizard context
Access Rights

This class can be accessed from:


SC DC Public Part ACH
[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
[sap.com] EP-RUNTIME [sap.com] com.sap.portal.admin.wizardframeworkdeprecated api EP-PIN-APF


Copyright 2011 SAP AG Complete Copyright Notice