| com.sun.rave.designtime.DesignBean
All known Subclasses: org.netbeans.modules.visualweb.insync.live.SourceDesignBean,
| DesignBean | | public interface DesignBean (Code) | | A DesignBean represents an instance of a JavaBean class at design-time. There is one
DesignBean instance 'wrapping' each instance of a component class in a bean design tool. All
access to properties and events should be done via the DesignBean interface at design-time, so
that the tool is able to track changes and persist them. Think of the "DesignBean" as the
design-time proxy for an instance of a JavaBean.
IMPLEMENTED BY CREATOR - This interface is implemented by Creator for use by the
component (bean) author.
author:
Joe Nuxoll
version:
1.0 |
| addDesignBeanListener | | public void addDesignBeanListener(DesignBeanListener beanListener)(Code) | | Adds a DesignBeanListener event listener to this DesignBean
Parameters:
beanListener - the event listener to add |
| canSetInstanceName | | public boolean canSetInstanceName()(Code) | | Returns true if this instance can be renamed via this interface.
true if this instance can be renamed via this interface, orfalse if not. |
| getBeanInfo | | public BeanInfo getBeanInfo()(Code) | | Returns the BeanInfo descriptor for this bean instance's type.
The BeanInfo descriptor for this bean instance's type. |
| getBeanParent | | public DesignBean getBeanParent()(Code) | | Returns the DesignBean parent of this bean instance, or null if this is a top-level bean.
The DesignBean parent of this bean instance, or null if this is a top-level bean. |
| getChildBean | | public DesignBean getChildBean(int index)(Code) | | Returns the child DesignBean at the specified cardinal index (zero-based).
Parameters:
index - The zero-based cardinal index for the desired DesignBean child the DesignBean at the specified index |
| getChildBeanCount | | public int getChildBeanCount()(Code) | | Returns the count of child DesignBeans contained in this DesignBean. Children are "logical"
children in that they represent the sub-components contained inside of another component in
the markup (JSP) or containership hiearchy.
The count of DesignBean children contained by this DesignBean |
| getChildBeans | | public DesignBean[] getChildBeans()(Code) | | Returns an array of DesignBean children of this DesignBean
An array of DesignBean children of this DesignBean |
| getDesignBeanListeners | | public DesignBeanListener[] getDesignBeanListeners()(Code) | | Returns an array of DesignBeanListener currently listening to this DesignBean
An array of DesignBeanListener currently listening to this DesignBean |
| getDesignContext | | public DesignContext getDesignContext()(Code) | | Returns the DesignContext that 'owns' this bean instance.
The DesignContext 'owner' of this bean instance. |
| getDesignInfo | | public DesignInfo getDesignInfo()(Code) | | Returns the DesignInfo instance for this bean instance.
The DesignInfo instance for this bean instance. |
| getEvent | | public DesignEvent getEvent(EventSetDescriptor eventSet, MethodDescriptor event)(Code) | | Returns the DesignEvent from within the specified event set and having the specified
MethodDescriptor.
Parameters:
eventSet - The desired EventSetDescriptor
Parameters:
event - The desired MethodDescriptor The DesignEvent representing the event desired, or null if none matched criteria |
| getEvent | | public DesignEvent getEvent(EventDescriptor event)(Code) | | Returns a DesignEvent with the specified EventDescriptor.
Parameters:
event - The desired event's EventDescriptor The DesignEvent representing the event desired, or null if none matched criteria |
| getEvents | | public DesignEvent[] getEvents()(Code) | | Returns an array of DesignEvent objects representing the events of this DesignBean.
An array of DesignEvent objecst representing the events of this DesignBean. |
| getEvents | | public DesignEvent[] getEvents(EventSetDescriptor eventSet)(Code) | | Returns the DesignEvent objects for a particular event set.
Parameters:
eventSet - The EventSetDescriptor containing the desired events. An array of DesignEvent objects representing the events contained in the specifiedevent set. |
| getInstance | | public Object getInstance()(Code) | | Returns the instance that this DesignBean is marshalling.
The instance of the wrapped bean instance. |
| getInstanceName | | public String getInstanceName()(Code) | | Returns the instance name of this bean - as declared in source code.
The source code instance name of this bean. |
| getProperties | | public DesignProperty[] getProperties()(Code) | | Returns an array of DesignProperty objects representing the properties of this DesignBean.
An array of DesignProperty objects representing the properties of this DesignBean. |
| getProperty | | public DesignProperty getProperty(String propertyName)(Code) | | Returns a single DesignProperty object representing the specified property (by name).
Parameters:
propertyName - The name of the desired DesignProperty to retrieve. The DesignProperty representing the desired property, or null if the specifiedproperty does not exist in this DesignBean. |
| getProperty | | public DesignProperty getProperty(PropertyDescriptor property)(Code) | | Returns a single DesignProperty object representing the specified property (by descriptor).
Parameters:
property - The PropertyDescriptor of the desired DesignProperty to retrieve. The DesignProperty representing the desired property, or null if the specifiedproperty does not exist in this DesignBean. |
| isContainer | | public boolean isContainer()(Code) | | Returns true if this DesignBean can be a logical container for other
DesignBeans, or false if not. For example, if a DesignBean is representing a
HtmlCommandButton instance, it will return false from this method, whereas a
DesignBean representing an HtmlDataTable will return true. You can only add
children to a DesignBean that returns true from this method.
true if this DesignBean is a container, and false if it isnot |
| removeDesignBeanListener | | public void removeDesignBeanListener(DesignBeanListener beanListener)(Code) | | Removes a DesignBeanListener event listener from this DesignBean
Parameters:
beanListener - the event listener to remove |
| setInstanceName | | public boolean setInstanceName(String name)(Code) | | Renames the instance variable for this bean instance in the source code. If successful,
this method returns true, if there is a problem, including the existance of a
duplicate instance variable name, this method returns false.
Parameters:
name - The desired source code instance name for this bean. true if the rename was successful, or false if not. |
| setInstanceName | | public boolean setInstanceName(String name, boolean autoNumber)(Code) | | Renames the instance variable for this bean instance in the source code, and appends an
auto-incremented number. For example: setInstanceName("button", true) --> button1 -->
button2 --> button3, etc. If successful, this method returns true, if there is
a problem, this method returns false.
Parameters:
name - The desired source code instance name (base) for this bean.
Parameters:
autoNumber - true to auto-number the instance name, false tostrictly attempt the specified name. true if the rename was successful, or false if not. |
|
|