com.dat.cx
Class CxLibraryComponent

java.lang.Object
  |
  +--com.dat.cx.CxComponent
        |
        +--com.dat.cx.CxCompositeComponent
              |
              +--com.dat.cx.CxLibraryComponent

All Implemented Interfaces:

CxExtendsListener, java.util.EventListener, com.d_a_t.expeval.ExpressionContext

Direct Known Subclasses:

CxGenericFilter, CxResource

public class CxLibraryComponent

extends CxCompositeComponent

CxLibraryComponent is the class root for all native library components. It provides the required behaviour to intergrate a native component into the Cx framework. It provides convenience methods for defining ports and properties.

Fields inherited from class com.dat.cx.CxComponent

compactDisplay, noHatDisplay, standardDisplay

Constructor Summary

CxLibraryComponent()

Method Summary

CxPin	definePin(java.lang.String name, boolean direction) Define a control pin.
CxXmlPort	definePort(java.lang.String name, boolean direction) Define a port.
CxProperty	defineProperty(java.lang.String name, java.lang.String value) Define a property.
CxProperty	defineProperty(java.lang.String name, java.lang.String value, boolean significant) Define a property.
CxResourceProviderProperty	defineResourceProviderProperty(java.lang.String name, java.lang.Class cls) Define a resource provider property.
CxResourceProviderProperty	defineResourceProviderProperty(java.lang.String name, java.lang.Class cls, boolean significant) Define a resource provider property.
boolean	exportChildren() Determine if child components are to be exported.
boolean	isLibraryComponent() Determines if the component is a library component
com.d_a_t.expeval.EEField	resolveField(java.lang.String identifier) Augmented to resolve any name which has a port name == field name in the data class as a field.

Methods inherited from class com.dat.cx.CxCompositeComponent

exportInfo, getCatchPort, getErrorPort, getIcon, importInfo, isCompositeComponent, makeInfo, setIcon

Methods inherited from class com.dat.cx.CxComponent

activate, addChild, addChildAt, addChildAtNoUndo, addChildNoUndo, addChildNoUndoAssign, addComponentChangeListener, addComponentChildrenListener, addExtendsListener, addSortedChild, canAddComponent, canExtendsAdd, componentAdded, componentLocationChanged, componentNameChanged, componentNodeChanged, componentPropertyChanged, componentRemoved, componentWirePortChanged, constructNode, contains, deactivate, decrUnresolved, export, exportContent, findPath, findPath, getBaseType, getChild, getChild, getChildren, getClassClause, getConfig, getConfigValue, getConfigValue, getDataPath, getDataPort, getDisplay, getDisplayStyle, getEditFrame, getExtendsFrom, getExtendsListeners, getImageIcon, getIndexOfChild, getInfo, getName, getNameInAncestor, getNameInContext, getNextChildTo, getNoChildren, getOwnerProject, getPackage, getPackage, getParent, getPort, getPropertyNames, getPropertyValues, getRoot, getRzChildren, getRzSortedChildren, getSortedChild, getSortedChildren, getSortedIndexOfChild, getViewFrame, getX, getXmlType, getY, handleException, hasChild, hasChild, hasChildren, hasDisplay, hasOverride, hasProperties, importContent, importSpec, importTemplate, incrUnresolved, init, instantiateChildComponent, instantiateChildComponentAt, isActive, isAttribute, isAttributeInstance, isBaseProperty, isConfiguration, isContentComponent, isDataMgr, isDataPort, isErrorCatchPort, isExtendable, isExtended, isInherited, isInterface, isMiniPort, isName, isNative, isPackage, isPalette, isPin, isPort, isPortMgr, isProperty, isRoot, isSubPortOf, isTextInstance, isTypePackage, isVar, isVarInstance, isVarSet, isWire, isXmlPort, isXmlPrimative, isXmlString, omitExport, removeChild, removeChild, removeChildNoUndo, removeComponentChangeListener, removeComponentChildrenListener, removeExtendsListener, renameSortedChild, resolveClass, resolveConstructor, resolveMethod, setClassClause, setComponentDefinitionServer, setDisplayStyle, setDisplayStyleFromInfo, setExtendsFrom, setInherited, setLocation, setLocationNoUndo, setName, setNameNoTrigger, setNameNoUndo, setNative, setOwnerProject, setParent, setPropertyValues, setX, setY, toString, triggerExtendsNodeChanged

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CxLibraryComponent

public CxLibraryComponent()

Method Detail

isLibraryComponent

public boolean isLibraryComponent()

Determines if the component is a library component

Overrides:

isLibraryComponent in class CxComponent

Returns:

true if the component is a library component, otherwise false

exportChildren

public boolean exportChildren()

Determine if child components are to be exported. For a library component the children are not exported

definePort

public CxXmlPort definePort(java.lang.String name,
                            boolean direction)

Define a port.

Parameters:

name - the port name

direction - true for provides, false for uses

Returns:

the created port

definePin

public CxPin definePin(java.lang.String name,
                       boolean direction)

Define a control pin.

Parameters:

name - the pin name

direction - true for provides, false for uses

Returns:

the created pin

defineProperty

public CxProperty defineProperty(java.lang.String name,
                                 java.lang.String value)

Define a property. The property will be defined to be significant. That is it will be displayed on the compoenent instance rendering when viewed within the Studio.

Parameters:

name - the property name

value - the initial value for the propery

Returns:

the created property

defineProperty

public CxProperty defineProperty(java.lang.String name,
                                 java.lang.String value,
                                 boolean significant)

Define a property.

Parameters:

name - the property name

value - the initial value for the propery

significant - indicates that a property is significant and should be displayed on the component instance rendering when viewed within the Studio.

Returns:

the created property

defineResourceProviderProperty

public CxResourceProviderProperty defineResourceProviderProperty(java.lang.String name,
                                                                 java.lang.Class cls)

Define a resource provider property.

Parameters:

class - the property name

class - the CxResource subclass needed to enable this resource

Returns:

the created property

defineResourceProviderProperty

public CxResourceProviderProperty defineResourceProviderProperty(java.lang.String name,
                                                                 java.lang.Class cls,
                                                                 boolean significant)

Define a resource provider property.

Parameters:

class - the property name

class - the CxResource subclass needed to enable this resource

significant - indicates that a property is significant and should be displayed on the component instance rendering when viewed within the Studio.

Returns:

the created property

resolveField

public com.d_a_t.expeval.EEField resolveField(java.lang.String identifier)
                                       throws com.d_a_t.expeval.ExpressionException

Augmented to resolve any name which has a port name == field name in the data class as a field.

Overrides:

resolveField in class CxComponent