de.hybris.platform.cmscockpit.wizard.page

Class MandatoryPage

java.lang.Object

de.hybris.platform.cockpit.wizards.impl.DefaultPage

de.hybris.platform.cmscockpit.wizard.page.AbstractCmsWizardPage

de.hybris.platform.cmscockpit.wizard.page.MandatoryPage

All Implemented Interfaces:

CmsWizardPage, WizardPage

Direct Known Subclasses:

BTGRuleEssentialsPage, CreatePageMandatoryPage

public class MandatoryPage
extends AbstractCmsWizardPage

Represents page that displays all necessary editors for required properties in order to create an instance of specified ObjectTemplate. This is used by cockpit wizards GenericItemWizard

Note:
User can configure properties that should be presented on that page by using wizard configuration

See Also:

GenericItemWizard, WizardConfiguration

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	COCKPIT_ID_CREATE_PAGE_PREFIX
protected static String	WIZARD_CONFIG
protected static String	WIZARD_GROUP_CONTAINER
protected static String	WIZARD_GROUP_EDITOR_CONTAINER
protected static String	WIZARD_GROUP_LABEL
protected static String	WIZARD_GROUP_ROW_LABEL
protected static String	WIZARD_SECTION

Fields inherited from class de.hybris.platform.cmscockpit.wizard.page.AbstractCmsWizardPage

CMSWIZARD_ERROR_CNT_SCLASS, CMSWIZARD_PAGE_CNT_SCLASS, CMSWIZARD_PAGE_CONTENT_CNT_SCLASS, CONTENT_ELEMENT_CONFIG, ERROR_SCLASS_CMSWIZARD_CNT, ERROR_SCLASS_ELEMENT_BOX_EDITOR, errorContainer, pageContainer, pageContent, SCLASS_ELEMENT_BOX_EDITOR

Fields inherited from class de.hybris.platform.cockpit.wizards.impl.DefaultPage

height, title, width, wizard

Constructor Summary

Constructors

Constructor and Description
MandatoryPage(String pageTitle, CmsWizard wizard)

Method Summary

Modifier and Type	Method and Description
protected AdvancedGroupbox	createGroup(HtmlBasedComponent parent, boolean open, String label) Creates one single group for particular page
protected Component	createGroupRow(Component parent, PropertyDescriptor descriptor, TypedObject currentObject, String editorCode, boolean error, Map<String,String> params) Creates one single row for group on that page.
protected void	createGroupSectionContent(HtmlBasedComponent group, Collection<String> allreadyDisplayedProperties, Collection<String> displaydDescriptors, WizardConfiguration wizardConfiguration) Creates a group content accordingly to given parameters
Component	createRepresentationItself()
protected List<String>	extractPropertyQualifiers(List<PropertyDescriptor> propertyDescriptors)
List<String>	getDisplayedAttributes()
Map<String,? extends Object>	getParameters()
protected UIConfigurationService	getUIConfigurationService()
Object	getValue()
protected WizardConfiguration	getWizardConfiguration()
boolean	isAddSelectedElementsAtTop()
protected void	loadInitConfigValues(PropertyDescriptor descriptor, WizardConfiguration wizardConfig) Method loads initial values that can be defined within WizardConfiguration
protected Radiogroup	positioningOptions()
protected void	render(HtmlBasedComponent parent, Collection<String> requiredDescriptors) Main method that is used for render whole page's content (i.e.
void	setParameters(Map<String,? extends Object> parameters)
void	setValue(Object value)

Methods inherited from class de.hybris.platform.cmscockpit.wizard.page.AbstractCmsWizardPage

clearPageComponents, getErrorContainer, getPageContainer, getPageContent, getWizard, handleMessages, isCauseError, setDisplayedAttributes

Methods inherited from class de.hybris.platform.cockpit.wizards.impl.DefaultPage

getAttributes, getComponentURI, getController, getCurrentController, getHeight, getId, getPageComponent, getTitle, getWidth, initView, renderView, setComponentURI, setController, setId, setPageComponent, setTitle, setWizard

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.hybris.platform.cockpit.wizards.WizardPage

getAttributes, getComponentURI, getController, getHeight, getId, getTitle, getWidth, initView

Field Detail

WIZARD_CONFIG

protected static final String WIZARD_CONFIG

See Also:

Constant Field Values

WIZARD_GROUP_LABEL

protected static final String WIZARD_GROUP_LABEL

See Also:

Constant Field Values

WIZARD_GROUP_CONTAINER

protected static final String WIZARD_GROUP_CONTAINER

See Also:

Constant Field Values

WIZARD_GROUP_EDITOR_CONTAINER

protected static final String WIZARD_GROUP_EDITOR_CONTAINER

See Also:

Constant Field Values

WIZARD_GROUP_ROW_LABEL

protected static final String WIZARD_GROUP_ROW_LABEL

See Also:

Constant Field Values

WIZARD_SECTION

protected static final String WIZARD_SECTION

See Also:

Constant Field Values

COCKPIT_ID_CREATE_PAGE_PREFIX

protected static final String COCKPIT_ID_CREATE_PAGE_PREFIX

See Also:

Constant Field Values

Constructor Detail

MandatoryPage

public MandatoryPage(String pageTitle,
                     CmsWizard wizard)

Method Detail

createGroupRow

protected final Component createGroupRow(Component parent,
                                         PropertyDescriptor descriptor,
                                         TypedObject currentObject,
                                         String editorCode,
                                         boolean error,
                                         Map<String,String> params)

Creates one single row for group on that page.

Parameters:

parent - parent component HtmlBasedComponent

descriptor - property descriptor for which editor should be displayed

currentObject - current object TypedObject

editorCode - editor code that should be used for displaying given properties

error - is this property causing error

params - configuration parameters

Returns:

a component that represents row within group

createGroupSectionContent

protected void createGroupSectionContent(HtmlBasedComponent group,
                                         Collection<String> allreadyDisplayedProperties,
                                         Collection<String> displaydDescriptors,
                                         WizardConfiguration wizardConfiguration)

Creates a group content accordingly to given parameters

Parameters:

group - parent @{link HtmlBasedComponent

allreadyDisplayedProperties - properties already displayed

displaydDescriptors - properties that should be displayed for that group

wizardConfiguration - wizard configuration

createRepresentationItself

public Component createRepresentationItself()

Specified by:

createRepresentationItself in interface CmsWizardPage

Specified by:

createRepresentationItself in class AbstractCmsWizardPage

createGroup

protected AdvancedGroupbox createGroup(HtmlBasedComponent parent,
                                       boolean open,
                                       String label)

Creates one single group for particular page

Parameters:

parent - component HtmlBasedComponent

open - flag that determines whether groups should be opened

label - group label

Returns:

a component that represents single group

positioningOptions

protected Radiogroup positioningOptions()

extractPropertyQualifiers

protected List<String> extractPropertyQualifiers(List<PropertyDescriptor> propertyDescriptors)

getDisplayedAttributes

public List<String> getDisplayedAttributes()

Overrides:

getDisplayedAttributes in class AbstractCmsWizardPage

Returns:

the displayedAttributes

getParameters

public Map<String,? extends Object> getParameters()

getUIConfigurationService

protected UIConfigurationService getUIConfigurationService()

getValue

public Object getValue()

getWizardConfiguration

protected WizardConfiguration getWizardConfiguration()

loadInitConfigValues

protected void loadInitConfigValues(PropertyDescriptor descriptor,
                                    WizardConfiguration wizardConfig)

Method loads initial values that can be defined within WizardConfiguration

Parameters:

descriptor - property descriptor

wizardConfig - current wizard configuration

render

protected void render(HtmlBasedComponent parent,
                      Collection<String> requiredDescriptors)

Main method that is used for render whole page's content (i.e. all group and rows configured via WizardConfiguration)

Parameters:

parent - component HtmlBasedComponent

requiredDescriptors - descriptors that are required in order to instantiate a given @{link ObjectTemplate

isAddSelectedElementsAtTop

public boolean isAddSelectedElementsAtTop()

setParameters

public void setParameters(Map<String,? extends Object> parameters)

setValue

public void setValue(Object value)