com.dat.cx
Class CxVarSet

java.lang.Object
  |
  +--com.dat.cx.CxComponent
        |
        +--com.dat.cx.CxVarSet
All Implemented Interfaces:
CxExtendsListener, java.util.EventListener, com.d_a_t.expeval.ExpressionContext

public class CxVarSet
extends CxComponent

CxVarSet provides semantics for a parenthisised set of vars.


Fields inherited from class com.dat.cx.CxComponent
compactDisplay, noHatDisplay, standardDisplay
 
Constructor Summary
CxVarSet()
          Default contstuctor
 
Method Summary
 XSet export(XSet doc, CxProject project)
          Export the definition of this varSet.
 boolean exportChildren()
           
 int getContentConstraint()
          Get the content constraint
 CxContentConstraint getContentConstraintProperty()
          Get the content constraint property
 java.lang.String getDataPath(CxComponent varRoot)
          Get the data path of a component relative to an ancestor
 com.dat.cx.studio.CxCompDisplay getDisplay()
          Get the display peer for this var set.
 java.lang.String getIcon()
          Get the icon file name for this component
 boolean getOrEnabled()
          Get the or enabled indicator
 java.util.Vector importSpec(XSet spec)
          Import specification from an XML element
 void importTemplate(CxComponent from, boolean copy, boolean inherit, boolean inverse)
          Import the definition of a type from another type ref set.
 boolean isVarSet()
          Determines if the component is a var set
 void setContentConstraint(int contentConstraint)
          Set the content constraint of the type reference.
 void setOrEnabled(boolean orEnabled)
          Set the or enabled indicator.
 
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, exportInfo, findPath, findPath, getBaseType, getChild, getChild, getChildren, getClassClause, getConfig, getConfigValue, getConfigValue, getDataPort, 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, importInfo, incrUnresolved, init, instantiateChildComponent, instantiateChildComponentAt, isActive, isAttribute, isAttributeInstance, isBaseProperty, isCompositeComponent, isConfiguration, isContentComponent, isDataMgr, isDataPort, isErrorCatchPort, isExtendable, isExtended, isInherited, isInterface, isLibraryComponent, isMiniPort, isName, isNative, isPackage, isPalette, isPin, isPort, isPortMgr, isProperty, isRoot, isSubPortOf, isTextInstance, isTypePackage, isVar, isVarInstance, isWire, isXmlPort, isXmlPrimative, isXmlString, makeInfo, 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

CxVarSet

public CxVarSet()
Default contstuctor
Method Detail

isVarSet

public boolean isVarSet()
Determines if the component is a var set
Overrides:
isVarSet in class CxComponent
Returns:
true if the component is a var set, otherwise false

getDataPath

public java.lang.String getDataPath(CxComponent varRoot)
Get the data path of a component relative to an ancestor
Overrides:
getDataPath in class CxComponent
Parameters:
varRoot - some component that is a root variable of this component
Returns:
the dataPath name from the varRoot to the component

getDisplay

public com.dat.cx.studio.CxCompDisplay getDisplay()
Get the display peer for this var set. The display peer handles the rendering of the type within the studio.
Overrides:
getDisplay in class CxComponent
Returns:
the display peer

importTemplate

public void importTemplate(CxComponent from,
                           boolean copy,
                           boolean inherit,
                           boolean inverse)
Import the definition of a type from another type ref set.
Overrides:
importTemplate in class CxComponent
Parameters:
from - the property from which to import a definition
copy - indicate that this is a copy 'vs' extends
inherit - indicate that the definition is inherited as part of an extends
inverse - (not used)

importSpec

public java.util.Vector importSpec(XSet spec)
Import specification from an XML element
Overrides:
importSpec in class CxComponent
Parameters:
spec - the xml element containing the specification

export

public XSet export(XSet doc,
                   CxProject project)
Export the definition of this varSet.
Overrides:
export in class CxComponent
Parameters:
doc - the XSet docuement being constructed. The definition is added to this document.
Returns:
the XSet document relative to the new definition

exportChildren

public boolean exportChildren()

getContentConstraintProperty

public CxContentConstraint getContentConstraintProperty()
Get the content constraint property
Returns:
the current constraint property

getContentConstraint

public int getContentConstraint()
Get the content constraint
Returns:
the constent constraint

setContentConstraint

public void setContentConstraint(int contentConstraint)
Set the content constraint of the type reference.
Parameters:
contentConstraint - the new content constraint

getOrEnabled

public boolean getOrEnabled()
Get the or enabled indicator
Returns:
true if or enabled, otherwise false

setOrEnabled

public void setOrEnabled(boolean orEnabled)
Set the or enabled indicator.
Parameters:
orEnabled - true if or is enabled, otherwise false.

getIcon

public java.lang.String getIcon()
Get the icon file name for this component
Overrides:
getIcon in class CxComponent
Returns:
the file name for the icon