| Constructor |
| Footer |
Footer(DeepGrid parentGrid) - creates
a footer for the parentGrid. This object is created by the system.
The developer must NOT create objects of type Footer |
| |
| Variables |
| String |
align - represents the Alignment property
of the Grid.Accessor Methods: getAlignment()/setAlignment() |
| String |
backgroundColor - represents the backgroundColor
property of the Grid.Accessor Methods: getbackgroundColor()/setBackgroundColor() |
| String |
backgroundImage - represents the backgroundImage
property of the Grid.Accessor Methods: getBackgroundImage()/setBackgroundImage() |
| Reserved |
cell - reference to the
internal cell object in the Footer row. Used Internally |
| Reserved |
colspan - represents
the number of columns the footer spans. Used Internally |
| String |
fontName - represents the fontName property
of the Grid.Accessor Methods: getFontName()/setFontName() |
| String |
fontSize - represents the fontSize property
of the Grid.Accessor Methods: getFontSize()/setFontSize() |
| String |
fontStyle - represents the fontStyle property
of the Grid.Accessor Methods: getForegroundColor()/setForegroundColor() |
| String |
footerText - represents the text that
is to be displayed in the Footer. Accessor Methods : getText()/setText()
getValue()/setValue() |
| String |
foregroundColor - represents the foregroundColor
property of the Grid.Accessor Methods: getForegroundColor()/setForegroundColor() |
| Reserved |
object - refers to the
current object. Used Internally |
| Readonly |
parent - reference to the parent DeepGrid |
| Reserved |
row - reference to the
internal representation of the Footer Row. Used Internally |
| Reserved |
tFoot - reference to
the internal representation of the Footer. Used Internally. |
| Boolean |
visible - toggle switch for the visible
property of the Footer. Default value is true |
| [ Top
] |
| |
| Method Summary |
| String |
getAlignment()- gets the Alignment for
the Footer. The default alignment is DG_LEFT |
| String |
getBackgroundColor()- gets the background
color of the Footer. The Default value is DG_NOCOLOR |
| String |
getBackgroundImage()- gets the backgroundImage
of the Footer. If there is no backgroundImage "" (empty string) is
returned |
| Reserved |
getCell() - Used Internally |
| Integer |
getColspan() - gets the number of columns
the Footer spans |
| String |
getFontName()- gets the FontName for the
Footer. The default is verdana |
| String |
getFontSize()- gets the FontSize of the
Footer. The default size is 10 |
| String |
getFontStyle()- gets the FontStyle of
the Footer. The default style is DG_NONE |
| String |
getForegroundColor()- gets the foreground
color of the Footer. |
| DeepGrid |
getGrid() - see getParent() |
| Reserved |
getObject() - Used Internally |
| DG_FOOTER |
getObjectID() - gets the Object type.
i.e. DG_FOOTER |
| DeepGrid |
getParent() - gets the parent DeepGrid
object |
| Reserved |
getRow() - Used Internally |
| DeepGrid |
getTable() - see getParent() |
| String |
getText() - gets the Footers text |
| Reserved |
getTFoot() - Used Internally |
| String |
getValue() - see getText() |
| Boolean |
isVisible() - gets the visible property
of the Footer |
| void |
setAlignment(String Alignment)- sets the
Alignment for the Footer. |
| void |
setBackgroundColor(String Color)- sets
the background color of the Footer. Note:Use DG_NOCOLOR for transparency. |
| void |
setBackgroundImage(String Image)- sets
the background image of the Footer to the image specified by 'Image'. |
| Reserved |
setColspan(Integer ColumnSpan) -
Used Internally |
| void |
setFont(String FontName, String FontStyle, Integer FontSize)-
sets the font properties of the Footer. FontName is the name of the
font, FontStyle is the style of the font (DG_NONE, DG_PLAIN, DG_BOLD,
DG_ITALIC, DG_BOLDITALIC), FontSize is the size of the text. |
| void |
setFontName(String FontName)- sets the
FontName for the Footer. |
| void |
setFontSize(Integer FontSize)- sets the
FontSize for the Footer |
| void |
setFontStyle(String FontStyle)- sets the
FontStyle for the Footer. The following are the predefined style constants
DG_NONE, DG_PLAIN, DG_BOLD, DG_ITALIC, DG_BOLDITALIC |
| void |
setForegroundColor(String Color)- sets
the foreground color of the Footer. |
| void |
setText(String DisplayText) - sets the
Footer text to DisplayText |
| void |
setValue(String DisplayText) - see setText(String
DisplayText) |
| void |
setVisible(Boolean State) - sets the visible
property of the Footer |