com.dat.cx
Class CxPin

java.lang.Object
  |
  +--com.dat.cx.CxComponent
        |
        +--com.dat.cx.CxPort
              |
              +--com.dat.cx.CxPin

All Implemented Interfaces:

CxExtendsListener, CxListener, CxPortInterface, CxSource, java.util.EventListener, com.d_a_t.expeval.ExpressionContext

public class CxPin

extends CxPort

CxPin provides semantics for a control pin component. A control pin allows processing to take place on receipt of any event. A control pin may produces an event.

Fields inherited from class com.dat.cx.CxComponent

compactDisplay, noHatDisplay, standardDisplay

Fields inherited from interface com.dat.cx.CxPortInterface

COMPOSITE, EVENT, INTERFACE, METHOD, PROVIDES, USES

Constructor Summary

CxPin()
Default constructor

CxPin(java.lang.String name, boolean direction)
Constructor

Method Summary

XSet	export(XSet doc, CxProject project) Export the definition of this pin (only this component)
com.dat.cx.studio.CxCompDisplay	getDisplay() Get the display peer for this pin.
com.dat.cx.studio.CxInternalFrame	getEditFrame(com.dat.cx.studio.CxStudio studio) Get at edit frame for editing this component.
java.lang.String	getIcon() Get the icon file name for this port
boolean	isPin() Determines if the component is a pin

Methods inherited from class com.dat.cx.CxPort

addCxListener, exportInfo, getCxListeners, getPortDirection, hasCxListeners, importInfo, importTemplate, inversePortDirection, isPort, makeInfo, recieve, removeCxListener, setPortDirection

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, exportContent, findPath, findPath, getBaseType, getChild, getChild, getChildren, getClassClause, getConfig, getConfigValue, getConfigValue, getDataPath, getDataPort, getDisplayStyle, 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, incrUnresolved, init, instantiateChildComponent, instantiateChildComponentAt, isActive, isAttribute, isAttributeInstance, isBaseProperty, isCompositeComponent, isConfiguration, isContentComponent, isDataMgr, isDataPort, isErrorCatchPort, isExtendable, isExtended, isInherited, isInterface, isLibraryComponent, isMiniPort, isName, isNative, isPackage, isPalette, isPortMgr, isProperty, isRoot, isSubPortOf, isTextInstance, isTypePackage, isVar, isVarInstance, isVarSet, isWire, isXmlPort, isXmlPrimative, isXmlString, omitExport, removeChild, removeChild, removeChildNoUndo, removeComponentChangeListener, removeComponentChildrenListener, removeExtendsListener, renameSortedChild, resolveClass, resolveConstructor, resolveField, 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

CxPin

public CxPin()

Default constructor

CxPin

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

Constructor

Parameters:

name - the name for the pin

direction - the direction of the pin, true for PROVIDES, false for USES

Method Detail

isPin

public boolean isPin()

Determines if the component is a pin

Overrides:

isPin in class CxComponent

Returns:

true if the component is a pin, otherwise false

getEditFrame

public com.dat.cx.studio.CxInternalFrame getEditFrame(com.dat.cx.studio.CxStudio studio)

Get at edit frame for editing this component.

Overrides:

getEditFrame in class CxPort

Returns:

the edit frame

export

public XSet export(XSet doc,
                   CxProject project)

Export the definition of this pin (only this component)

Overrides:

export in class CxPort

Parameters:

doc - the XSet document being constructed. The definition is added to this document

Returns:

the XSet document relative to the new definition

getDisplay

public com.dat.cx.studio.CxCompDisplay getDisplay()

Get the display peer for this pin. The display peer handles the rendering of the pin within the studio.

Overrides:

getDisplay in class CxPort

Returns:

the display peer

getIcon

public java.lang.String getIcon()

Get the icon file name for this port

Overrides:

getIcon in class CxPort

Returns:

the file name for the icon