org.openbp.cockpit.generator
Class GeneratorPageDescriptor

java.lang.Object
  extended by org.openbp.common.generic.description.DescriptionObjectImpl
      extended by org.openbp.common.generic.description.DisplayObjectImpl
          extended by org.openbp.cockpit.generator.GeneratorPageDescriptor
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, java.lang.Comparable, Copyable, DescriptionObject, Displayable, DisplayObject, Validatable

public class GeneratorPageDescriptor
extends DisplayObjectImpl

Descriptor class for a custom wizard page of a generator process. The class may either contain a reference to a class that can be used directly as wizard page or a class that defines an object that should be edited using the generator's default property browser page. This class is a subclass of DisplayObject. The name is also the sequence name of the wizard page. This name can be used from within the template to access the object instance edited by this page.
The display name will be used as title of the wizard page and must be present. If there is no display name, the display name of the Generator object that owns this page descriptor will be used.
The description property is used as page description.

Author:
Heiko Erhardt
See Also:
Serialized Form

Field Summary
 
Fields inherited from interface org.openbp.common.generic.Copyable
COPY_DEEP, COPY_FIRST_LEVEL, COPY_SHALLOW
 
Constructor Summary
GeneratorPageDescriptor()
          Default constructor.
 
Method Summary
 java.lang.Class getObjectClass()
          Gets the object class name.
 java.lang.String getObjectClassName()
          Gets the object class name.
 java.lang.Class getPageClass()
          Gets the page class name.
 java.lang.String getPageClassName()
          Gets the page class name.
 boolean isFinish()
          Gets the finish wizard flag.
 void setFinish(boolean finish)
          Sets the finish wizard flag.
 void setObjectClass(java.lang.Class objectClass)
          Sets the object class name.
 void setObjectClassName(java.lang.String objectClassName)
          Sets the object class name.
 void setPageClass(java.lang.Class pageClass)
          Sets the page class name.
 void setPageClassName(java.lang.String pageClassName)
          Sets the page class name.
 
Methods inherited from class org.openbp.common.generic.description.DisplayObjectImpl
copyFrom, getDisplayName, getDisplayText, setDisplayName
 
Methods inherited from class org.openbp.common.generic.description.DescriptionObjectImpl
clone, compareTo, getDescription, getDescriptionEscape, getDescriptionText, getName, setDescription, setDescriptionEscape, setName, toString, validate
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.openbp.common.generic.description.DescriptionObject
clone, getDescription, getDescriptionText, getName, setDescription, setName
 
Methods inherited from interface java.lang.Comparable
compareTo
 

Constructor Detail

GeneratorPageDescriptor

public GeneratorPageDescriptor()
Default constructor.

Method Detail

getPageClassName

public java.lang.String getPageClassName()
Gets the page class name.


setPageClassName

public void setPageClassName(java.lang.String pageClassName)
Sets the page class name.


getObjectClassName

public java.lang.String getObjectClassName()
Gets the object class name.


setObjectClassName

public void setObjectClassName(java.lang.String objectClassName)
Sets the object class name.


getPageClass

public java.lang.Class getPageClass()
Gets the page class name.


setPageClass

public void setPageClass(java.lang.Class pageClass)
Sets the page class name.


getObjectClass

public java.lang.Class getObjectClass()
Gets the object class name.


setObjectClass

public void setObjectClass(java.lang.Class objectClass)
Sets the object class name.


isFinish

public boolean isFinish()
Gets the finish wizard flag.


setFinish

public void setFinish(boolean finish)
Sets the finish wizard flag.



Copyright © 2011. All Rights Reserved.