Class GenericItemMandatoryPage

All Implemented Interfaces:
GenericItemWizardPage, WizardPage
Direct Known Subclasses:
CmsSiteSummaryPage, ConstraintsMandatoryPage

public class GenericItemMandatoryPage extends AbstractGenericItemPage
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:
  • Field Details

  • Constructor Details

    • GenericItemMandatoryPage

      public GenericItemMandatoryPage()
    • GenericItemMandatoryPage

      public GenericItemMandatoryPage(String pageTitle)
    • GenericItemMandatoryPage

      public GenericItemMandatoryPage(String pageTitle, GenericItemWizard wizard)
  • Method Details

    • getDefaultController

      public DefaultGenericItemMandatoryPageController getDefaultController()
    • setDefaultController

      public void setDefaultController(DefaultGenericItemMandatoryPageController defaultController)
    • getController

      public WizardPageController getController()
      Specified by:
      getController in interface WizardPage
      Overrides:
      getController in class DefaultPage
    • createGroupRow

      protected final org.zkoss.zk.ui.Component createGroupRow(org.zkoss.zk.ui.Component parent, PropertyDescriptor descriptor, TypedObject currentObject, String editorCode, int errorLevel, 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
      errorLevel - is this property causing error
      params - configuration parameters
      Returns:
      a component that represents row within group
    • createGroupSectionContent

      protected void createGroupSectionContent(org.zkoss.zk.ui.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 org.zkoss.zk.ui.Component createRepresentationItself()
      Description copied from class: AbstractGenericItemPage
      This is an general method responsible for creating UI representation of given page

      Note:
      Here we should create graphical representation of particular page

      Specified by:
      createRepresentationItself in interface GenericItemWizardPage
      Specified by:
      createRepresentationItself in class AbstractGenericItemPage
    • createGroup

      protected AdvancedGroupbox createGroup(org.zkoss.zk.ui.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
    • extractPropertyQualifiers

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

      public List<String> getDisplayedAttributes()
      Overrides:
      getDisplayedAttributes in class AbstractGenericItemPage
      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(org.zkoss.zk.ui.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
    • setParameters

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

      public void setValue(Object value)