Extension SDK 9.0.5

oracle.jdeveloper.cmt
Interface CmtSubcomponent

All Superinterfaces:
SupportsInspection

public interface CmtSubcomponent
extends SupportsInspection


Field Summary
static int CLASS_SCOPE
          Declared as a member in outer CmtComponent
static int METHOD_SCOPE
          Declared as local variable within a method of outer CmtComponent.
 
Method Summary
 CmtPropertyState addPropertyState(CmtProperty property)
          Allows models to add/remove property states to/from this subcomponent
 void addPropertyState(CmtPropertyState propertyState)
           
 CmtSubcomponent copy(CmtComponentSource toFile, java.util.List subcomponentList, boolean toClipboard)
          copy this subcomponent into another file returns the copied subcomponent
 java.awt.Container getAsContainer()
          Returns either this.getLiveInstance() (most common case), or this.getLiveInstance().XXX() where XXX is defined in the BeanDescriptor.getValue("containerDelegate").
 JotAssignment getAssignment()
           
 CmtComponent getComponent()
           
 JotClass getComponentType()
           
 JotClass getDeclaredClass()
           
 CmtEventState getDefaultEventState()
           
 CmtPropertyState getDefaultPropertyState()
           
 CmtEventState getEventState(java.lang.String name)
           
 CmtEventState[] getEventStates()
          Returns objects representing the state of all properties, hence all potential property settings, including those that are not explicitly set in the init method
 CmtMethod getInitMethod()
           
 JotClass getLiveClass()
           
 java.lang.Object getLiveInstance()
           
 java.lang.String getName()
           
 CmtComponent getOuterComponent()
           
 CmtPropertyState getPropertyState(java.lang.String name)
           
 CmtPropertyState[] getPropertyStates()
          Returns objects representing the state of all properties, hence all potential property settings, including those that are not explicitly set in the init method
 JotClass getRepresentedType()
          Gets the JotClass for the otherwise unrepresentable type that this instance is a proxy for.
 int getScope()
           
 java.lang.String getSourceName()
          distinguish subcomponents fetched via method calls (e.g.
 JotVariable getVariable()
           
 boolean isProxy()
          Determine whether or not this instance is actually a proxy representing an otherwise unrepresentable type.
 boolean isStale()
          Determine whether or not this instance is still a valid reference.
 void release()
          Called when subcomponent is about to fall out of scope.
 void removePropertyState(CmtPropertyState propertyState)
           
 void serialize()
           
 void setAssignment(JotAssignment assign)
           
 void setAssignment(java.lang.String expressionText)
           
 void setLiveClass(java.lang.String classname)
           
 void setName(java.lang.String name)
           
 

Field Detail

METHOD_SCOPE

public static final int METHOD_SCOPE
Declared as local variable within a method of outer CmtComponent.

See Also:
Constant Field Values

CLASS_SCOPE

public static final int CLASS_SCOPE
Declared as a member in outer CmtComponent

See Also:
Constant Field Values
Method Detail

getName

public java.lang.String getName()

setName

public void setName(java.lang.String name)

getSourceName

public java.lang.String getSourceName()
distinguish subcomponents fetched via method calls (e.g. dm1.getDataSet1().getQuery();)


getDeclaredClass

public JotClass getDeclaredClass()

getLiveClass

public JotClass getLiveClass()

setLiveClass

public void setLiveClass(java.lang.String classname)

getComponent

public CmtComponent getComponent()

getComponentType

public JotClass getComponentType()

isProxy

public boolean isProxy()
Determine whether or not this instance is actually a proxy representing an otherwise unrepresentable type.


isStale

public boolean isStale()
Determine whether or not this instance is still a valid reference.

Returns:
true when this instance is no longer a valid reference.

getRepresentedType

public JotClass getRepresentedType()
Gets the JotClass for the otherwise unrepresentable type that this instance is a proxy for.

See Also:
isProxy()

getOuterComponent

public CmtComponent getOuterComponent()

getInitMethod

public CmtMethod getInitMethod()

getScope

public int getScope()

getPropertyStates

public CmtPropertyState[] getPropertyStates()
Returns objects representing the state of all properties, hence all potential property settings, including those that are not explicitly set in the init method


getPropertyState

public CmtPropertyState getPropertyState(java.lang.String name)

getDefaultPropertyState

public CmtPropertyState getDefaultPropertyState()

addPropertyState

public CmtPropertyState addPropertyState(CmtProperty property)
Allows models to add/remove property states to/from this subcomponent


addPropertyState

public void addPropertyState(CmtPropertyState propertyState)

removePropertyState

public void removePropertyState(CmtPropertyState propertyState)

getEventStates

public CmtEventState[] getEventStates()
Returns objects representing the state of all properties, hence all potential property settings, including those that are not explicitly set in the init method


getEventState

public CmtEventState getEventState(java.lang.String name)

getDefaultEventState

public CmtEventState getDefaultEventState()

getLiveInstance

public java.lang.Object getLiveInstance()

release

public void release()
Called when subcomponent is about to fall out of scope. All usage after this point is undefined.


copy

public CmtSubcomponent copy(CmtComponentSource toFile,
                            java.util.List subcomponentList,
                            boolean toClipboard)
copy this subcomponent into another file returns the copied subcomponent


serialize

public void serialize()
               throws java.io.NotSerializableException,
                      java.io.IOException
Throws:
java.io.NotSerializableException
java.io.IOException

getVariable

public JotVariable getVariable()

getAssignment

public JotAssignment getAssignment()

setAssignment

public void setAssignment(JotAssignment assign)

setAssignment

public void setAssignment(java.lang.String expressionText)

getAsContainer

public java.awt.Container getAsContainer()
Returns either this.getLiveInstance() (most common case), or this.getLiveInstance().XXX() where XXX is defined in the BeanDescriptor.getValue("containerDelegate"). Basically Swing introduced the notion of container delegates for certain properties, and this api was created explicitly for that.


Extension SDK

 

Copyright © 1997, 2004, Oracle. All rights reserved.