Home > Class Reference > ENSLIB namespace > %ZEN.Component.component

%ZEN.Component.component

abstract class %ZEN.Component.component extends %ZEN.Component.object

This is the base class for all visual, HTML-based Zen components.

Property Inventory (Including Private)

Method Inventory (Including Private)

Parameters

parameter DEFAULTENCLOSINGCLASS = zendiv;
Subclasses can set this to change default enclosingClass used for this component.
parameter DEFAULTHEIGHT;
Subclasses can set this to change default height for a component.
parameter DEFAULTHIDDEN = 0;
Subclasses can set this to change default hidden property for a component.
parameter DEFAULTHINTCLASS = zenHint;
Subclasses can set this to change default css class used for hints.
parameter DEFAULTLABELCLASS = zenLabel;
Subclasses can set this to change default css class used for labels.
parameter DEFAULTLABELDISABLEDCLASS = zenLabelDisabled;
Subclasses can set this to change default css class used for disabled labels.
parameter DEFAULTVISIBLE = 1;
Subclasses can set this to change default visibilty for a component.
parameter DEFAULTWIDTH;
Subclasses can set this to change default width for a component.

Properties (Including Private)

property align as %ZEN.Datatype.align;
Specifies how this component should be horizontally aligned within its layout cell.
Property methods: alignDisplayToLogical(), alignGet(), alignIsValid(), alignLogicalToDisplay(), alignLogicalToOdbc(), alignNormalize(), alignSet()
property containerStyle as %ZEN.Datatype.style;
CSS style applied to the td element used to contain this child component within its parent group's layout table. This overrides the parent group's cellStyle property for this child. Typically this is used to provide padding or alignment for a specific component. This only applies to layout strategies that use tables.
Property methods: containerStyleDisplayToLogical(), containerStyleGet(), containerStyleIsValid(), containerStyleLogicalToDisplay(), containerStyleLogicalToOdbc(), containerStyleNormalize(), containerStyleSet()
property dragEnabled as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
If this value is true and dragAndDrop is enabled for the page, then this component can serve as a drag source (i.e., users can start a drag and drop operation over this component). The actual behavior is determined by the subclass implementation.
Property methods: dragEnabledDisplayToLogical(), dragEnabledGet(), dragEnabledIsValid(), dragEnabledLogicalToDisplay(), dragEnabledLogicalToOdbc(), dragEnabledLogicalToXSD(), dragEnabledNormalize(), dragEnabledSet(), dragEnabledXSDToLogical()
property dropEnabled as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
If this value is true and dragAndDrop is enabled for the page, then this component can serve as a drag target (i.e., users can end a drag and drop operation over this component). The actual behavior is determined by the subclass implementation.
Property methods: dropEnabledDisplayToLogical(), dropEnabledGet(), dropEnabledIsValid(), dropEnabledLogicalToDisplay(), dropEnabledLogicalToOdbc(), dropEnabledLogicalToXSD(), dropEnabledNormalize(), dropEnabledSet(), dropEnabledXSDToLogical()
property enclosingClass as %ZEN.Datatype.cssClass [ InitialExpression = ..#DEFAULTENCLOSINGCLASS ];
Optional CSS class used for this component's enclosing div.
Property methods: enclosingClassDisplayToLogical(), enclosingClassGet(), enclosingClassIsValid(), enclosingClassLogicalToDisplay(), enclosingClassLogicalToOdbc(), enclosingClassNormalize(), enclosingClassSet()
property enclosingStyle as %ZEN.Datatype.style;
Optional CSS style applied to this component's enclosing div.
Property methods: enclosingStyleDisplayToLogical(), enclosingStyleGet(), enclosingStyleIsValid(), enclosingStyleLogicalToDisplay(), enclosingStyleLogicalToOdbc(), enclosingStyleNormalize(), enclosingStyleSet()
property error as %ZEN.Datatype.string (XMLPROJECTION = "none", ZENSETTING = 0);
Run-time value; Set to indicate an error within this component.
This is primarily used by controls. It is defined here for flexibility.
Property methods: errorDisplayToLogical(), errorGet(), errorIsValid(), errorLogicalToDisplay(), errorLogicalToOdbc(), errorNormalize(), errorSet()
property height as %ZEN.Datatype.length [ InitialExpression = ..#DEFAULTHEIGHT ];
Specifies the height of this component with respect to its container.
Property methods: heightDisplayToLogical(), heightGet(), heightIsValid(), heightLogicalToDisplay(), heightLogicalToOdbc(), heightNormalize(), heightSet()
property hidden as %ZEN.Datatype.boolean (ZENEXPRESSION = 1) [ InitialExpression = ..#DEFAULTHIDDEN ];
If true, this component is hidden. That is, its enclosing element's display style is set to "none".
Property methods: hiddenDisplayToLogical(), hiddenGet(), hiddenIsValid(), hiddenLogicalToDisplay(), hiddenLogicalToOdbc(), hiddenLogicalToXSD(), hiddenNormalize(), hiddenSet(), hiddenXSDToLogical()
property hint as %ZEN.Datatype.caption;
User defined hint text used to display additional hint text for this component. If specified, the hint text is drawn below the component.
Property methods: hintClassDisplayToLogical(), hintClassGet(), hintClassIsValid(), hintClassLogicalToDisplay(), hintClassLogicalToOdbc(), hintClassNormalize(), hintClassSet(), hintDisplayToLogical(), hintGet(), hintIsValid(), hintLogicalToDisplay(), hintLogicalToOdbc(), hintNormalize(), hintSet(), hintStyleDisplayToLogical(), hintStyleGet(), hintStyleIsValid(), hintStyleLogicalToDisplay(), hintStyleLogicalToOdbc(), hintStyleNormalize(), hintStyleSet()
property hintClass as %ZEN.Datatype.cssClass [ InitialExpression = ..#DEFAULTHINTCLASS ];
Optional CSS class used for the component hint.
Property methods: hintClassDisplayToLogical(), hintClassGet(), hintClassIsValid(), hintClassLogicalToDisplay(), hintClassLogicalToOdbc(), hintClassNormalize(), hintClassSet()
property hintStyle as