oracle.jdeveloper.cmt

Interface CmtSubcomponent

All Superinterfaces:

SupportsInspection

public interface CmtSubcomponent
extends SupportsInspection

Field Summary

Fields

Modifier and Type	Field and Description
static int	CLASS_SCOPE Declared as a member in outer CmtComponent
static java.lang.String	FIELDNAME_PROPERTY_NAME Property identifier for pseudo 'name' property.
static int	METHOD_SCOPE Declared as local variable within a method of outer CmtComponent.

Method Summary

Modifier and Type	Method and Description
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").
SourceAssignmentExpression	getAssignment()
CmtComponent	getComponent()
JavaClass	getComponentType()
JavaClass	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()
JavaClass	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
JavaClass	getRepresentedType() Gets the JavaClass for the otherwise unrepresentable type that this instance is a proxy for.
int	getScope()
SourceVariable	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(SourceAssignmentExpression assign)
void	setAssignment(java.lang.String expressionText)
void	setLiveClass(java.lang.String classname)

Field Detail

FIELDNAME_PROPERTY_NAME

static final java.lang.String FIELDNAME_PROPERTY_NAME

Property identifier for pseudo 'name' property.

See Also:

Constant Field Values

METHOD_SCOPE

static final int METHOD_SCOPE

Declared as local variable within a method of outer CmtComponent.

See Also:

Constant Field Values

CLASS_SCOPE

static final int CLASS_SCOPE

Declared as a member in outer CmtComponent

See Also:

Constant Field Values

Method Detail

getName

java.lang.String getName()

getDeclaredClass

JavaClass getDeclaredClass()

getLiveClass

JavaClass getLiveClass()

setLiveClass

void setLiveClass(java.lang.String classname)

getComponent

CmtComponent getComponent()

getComponentType

JavaClass getComponentType()

isProxy

boolean isProxy()

Determine whether or not this instance is actually a proxy representing an otherwise unrepresentable type.

isStale

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

JavaClass getRepresentedType()

Gets the JavaClass for the otherwise unrepresentable type that this instance is a proxy for.

See Also:

isProxy()

getOuterComponent

CmtComponent getOuterComponent()

getInitMethod

CmtMethod getInitMethod()

getScope

int getScope()

getPropertyStates

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

CmtPropertyState getPropertyState(java.lang.String name)

getDefaultPropertyState

CmtPropertyState getDefaultPropertyState()

addPropertyState

CmtPropertyState addPropertyState(CmtProperty property)

Allows models to add/remove property states to/from this subcomponent

addPropertyState

void addPropertyState(CmtPropertyState propertyState)

removePropertyState

void removePropertyState(CmtPropertyState propertyState)

getEventStates

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

CmtEventState getEventState(java.lang.String name)

getDefaultEventState

CmtEventState getDefaultEventState()

getLiveInstance

java.lang.Object getLiveInstance()

release

void release()

Called when subcomponent is about to fall out of scope. All usage after this point is undefined.

copy

CmtSubcomponent copy(CmtComponentSource toFile,
                     java.util.List subcomponentList,
                     boolean toClipboard)

copy this subcomponent into another file returns the copied subcomponent

serialize

void serialize()
        throws java.io.NotSerializableException,
               java.io.IOException

Throws:

java.io.NotSerializableException

java.io.IOException

getVariable

SourceVariable getVariable()

getAssignment

SourceAssignmentExpression getAssignment()

setAssignment

void setAssignment(SourceAssignmentExpression assign)

setAssignment

void setAssignment(java.lang.String expressionText)

getAsContainer

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.