com.arsdigita.cms.ui.authoring
Class AuthoringKitWizard

java.lang.Object
  extended bycom.arsdigita.bebop.Completable
      extended bycom.arsdigita.bebop.SimpleComponent
          extended bycom.arsdigita.toolbox.ui.ComponentMap
              extended bycom.arsdigita.toolbox.ui.LayoutPanel
                  extended bycom.arsdigita.cms.ui.authoring.AuthoringKitWizard
All Implemented Interfaces:
Cloneable, com.arsdigita.bebop.Component, com.arsdigita.util.Lockable, com.arsdigita.bebop.Resettable

public class AuthoringKitWizard
extends com.arsdigita.toolbox.ui.LayoutPanel
implements com.arsdigita.bebop.Resettable

This class represents a single authoring kit. The wizard accepts a ContentType in the constructor; it then extracts the AuthoringKit for the content type, and creates the components for all the steps in the kit.

Note that the individual authoring kit steps must provide the following constructor:


 public TheClass(ItemSelectionModel model, AuthoringKitWizard parent) { ... }
 
This constructor will be called when the component is automatically instantiated by the AuthoringKitWizard.

Version:
$Id: //cms/dev/src/com/arsdigita/cms/ui/authoring/AuthoringKitWizard.java#27 $

Field Summary
static String CREATION
          The key for the item creation step.
static String IS_EDITING
          The name of the state parameter that determines whether the wizard is in item creation mode or item editing mode.
static String versionId
           
 
Fields inherited from class com.arsdigita.bebop.SimpleComponent
m_attr
 
Fields inherited from interface com.arsdigita.bebop.Component
BEBOP_XML_NS, CLASS, ID, ON_CLICK, STYLE
 
Constructor Summary
AuthoringKitWizard(ContentType type, ItemSelectionModel model)
          Construct a new AuthoringKitWizard.
 
Method Summary
 AuthoringKit getAuthoringKit()
           
 ContentType getContentType()
           
 ItemSelectionModel getItemSelectionModel()
           
 com.arsdigita.bebop.List getList()
           
protected static com.arsdigita.globalization.GlobalizedMessage gz(String key)
           
protected  com.arsdigita.bebop.Component instantiateStep(String name)
          Instantiate the specified authoring kit step.
protected  com.arsdigita.bebop.Component instantiateUserDefinedStep(String name, ContentType originatingType)
          Instantiate the specified authoring kit step for a user defined content type.
protected static String lz(String key)
           
 void register(com.arsdigita.bebop.Page page)
           
static void registerAssetStep(String baseObjectType, Class step, com.arsdigita.globalization.GlobalizedMessage label, com.arsdigita.globalization.GlobalizedMessage description, int sortKey)
           
 void reset(com.arsdigita.bebop.PageState state)
          Reset the state of this wizard
 
Methods inherited from class com.arsdigita.toolbox.ui.LayoutPanel
generateXML, setBody, setBottom, setLeft, setRight, setTop
 
Methods inherited from class com.arsdigita.toolbox.ui.ComponentMap
children, containsKey, containsValue, get, put
 
Methods inherited from class com.arsdigita.bebop.SimpleComponent
clone, exportAttributes, getAttribute, getClassAttr, getIdAttr, getKey, getMetaDataAttribute, getStyleAttr, hasAttributes, isLocked, isVisible, lock, register, respond, setAttribute, setClassAttr, setIdAttr, setKey, setMetaDataAttribute, setStyleAttr, setVisible
 
Methods inherited from class com.arsdigita.bebop.Completable
addCompletionListener, fireCompletionEvent
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

versionId

public static final String versionId
See Also:
Constant Field Values

IS_EDITING

public static final String IS_EDITING
The name of the state parameter that determines whether the wizard is in item creation mode or item editing mode.

See Also:
Constant Field Values

CREATION

public static final String CREATION
The key for the item creation step.

See Also:
Constant Field Values
Constructor Detail

AuthoringKitWizard

public AuthoringKitWizard(ContentType type,
                          ItemSelectionModel model)
Construct a new AuthoringKitWizard. Add all the steps in the authoring kit to the wizard.

Parameters:
type - The content type of the items that this wizard will handle
Method Detail

registerAssetStep

public static void registerAssetStep(String baseObjectType,
                                     Class step,
                                     com.arsdigita.globalization.GlobalizedMessage label,
                                     com.arsdigita.globalization.GlobalizedMessage description,
                                     int sortKey)

register

public final void register(com.arsdigita.bebop.Page page)
Specified by:
register in interface com.arsdigita.bebop.Component

getContentType

public ContentType getContentType()
Returns:
The content type handled by this wizard

getList

public com.arsdigita.bebop.List getList()

getAuthoringKit

public AuthoringKit getAuthoringKit()
Returns:
The authoring kit which is represented by this wizard

getItemSelectionModel

public ItemSelectionModel getItemSelectionModel()
Returns:
The ItemSelectionModel used by the steps in this wizard

instantiateStep

protected com.arsdigita.bebop.Component instantiateStep(String name)
Instantiate the specified authoring kit step. Will throw a RuntimeException on failure.


instantiateUserDefinedStep

protected com.arsdigita.bebop.Component instantiateUserDefinedStep(String name,
                                                                   ContentType originatingType)
Instantiate the specified authoring kit step for a user defined content type. Will throw a RuntimeException on failure.


reset

public final void reset(com.arsdigita.bebop.PageState state)
Reset the state of this wizard

Specified by:
reset in interface com.arsdigita.bebop.Resettable

gz

protected static final com.arsdigita.globalization.GlobalizedMessage gz(String key)

lz

protected static final String lz(String key)


Copyright (c) 2004 Red Hat, Inc. Corporation. All Rights Reserved. Generated at July 21 2004:2352 UTC