Home Index General Info API / Developers Manual Demos Download Contact
ColumnHeaders
Constructor
Reserved ColumnHeaders ColumnHeaders(String GridName) - Create a ColumnHeaders object for the specified grid. The object is created by the system. The developer must NOT create objects of type columnHeaders
 
Variables
String align - represents the Alignment property of the Grid.Accessor Methods: getAlignment()/setAlignment()
Reserved arrColumns - Collection of Columns. Used Internally
Reserved arrcolumns - see arrColumns
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()
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 foregroundColor - represents the foregroundColor property of the Grid.Accessor Methods: getForegroundColor()/setForegroundColor()
Reserved object - reference to the current object. Used Internally
Readonly parent- reference to the parent DeepGrid Object
Boolean raised- Toggle switch for raised effect in Column Headers. Accessor Methods: setRaised()/isRaised()
Reserved row - reference to the column row of the table. Used Internally
Reserved tHead - reference to the tHead section of the table. Used Internally
[ Top ]
 
Method Summary
Column add([Integer ColumnIndex], [String Key], [String ColumnName], [String ColumnHeaderIcon], [Integer Width], [String Alignment], [ColumnTypeConstant ColumnType], [String DefaultValue], [String RowIcon], [String ScriptEvents], [String InlineStyles])- used to add a new Column in the grid. All the arguments are optional, you can also pass null for arguments that you do not wish to pass. Calling this method with no arguments results in creation of a Column at the end of the table with no ColumnLabel and with Label elements. The various arguments are
  • ColumnIndex - Specifies the position into which the Column is to be inserted. If value to this argument is not passed the column will get appended to the end of the grid.
  • Key - Unique identifier for the column. If the Key is provided, the column can be accessed by using the key name as a argument for getColumn(String ColumnIndex).
  • ColumnName - The text that is displayed on the column header
  • ColumnHeaderIcon - represents the name of the icon that is to be displayed on the Column Header.
  • Width - specifies the width of the column. Width can be specified as a whole number or as a percentage.
  • Alignment - Specifies the Alignment of the ColumnHeader.
  • ColumnType - represents the ColumnType of the Column. ColumnTypes can be DG_TEXT, DG_SELECT, DG_READONLY, DG_CHECKBOX, DG_RADIO, DG_PASSWORD, DG_TEXTAREA, DG_HIDDEN, DG_FILE, DG_TEXTX, DG_IMAGE, DG_NUMERIC, DG_BOOLEAN, DG_LABEL. For more information on the ColumnTypes refer to the section on Constants.
  • DefaultValue - represents the default value that must be set on creation of the cells in the column.
  • RowIcon - The image specified by RowIcon is set as the Icon in each row of this Column.
  • ScriptEvents - User-defined scripts can be provided here.
  • InlineStyles - User-defined styles can be provided here.
    • Column addColumn([Integer ColumnIndex], [String Key], [String ColumnName], [String ColumnHeaderIcon], [Integer Width], [ColumnTypeConstant ColumnType], [String Alignment], [String DefaultValue], [String RowIcon], [String ScriptEvents], [String InlineStyles])- see add([Integer ColumnIndex], [String Key], [String ColumnName], [String ColumnHeaderIcon], [Integer Width], [ColumnTypeConstant ColumnType], [String Alignment], [String DefaultValue], [String RowIcon], [String ScriptEvents], [String InlineStyles]
    Column Columns(ColumnIndex Index)- gets the Column in the position specified by the Index. Index can either be the Column number or the Column key if present.
    Column columns(ColumnIndex Index)- see Column(ColumnIndex Index).
    void deleteColumn(ColumnIndex Index) - deletes the Column in the position specified by the Index. Index can either be the Column number or the Column key if present.
    String getAlignment()- gets the Alignment for the ColumnHeaders. The default alignment is DG_LEFT
    String getBackgroundColor()- gets the background color of the ColumnHeaders. The Default value is DG_NOCOLOR
    String getBackgroundImage()- gets the backgroundImage of the ColumnHeaders. If there is no backgroundImage "" (empty string) is returned
    Integer getColumnCount()- gets the total number of columns.
    Array getColumnDetails(Integer ColumnIndex)- returns a array containing the Column properties.
    String getFontName()- gets the FontName for the ColumnHeaders. The default is verdana
    String getFontSize()- gets the FontSize of the ColumnHeaders. The default size is 10
    String getFontStyle()- gets the FontStyle of the ColumnHeaders. The default style is DG_NONE
    String getForegroundColor()- gets the foreground color of the ColumnHeaders.
    DeepGrid getGrid()- see getParent()
    Array getHeaderDetails()- returns a array containing nested Arrays of the Column properties.
    Integer getLength()- see getColumnCount().
    Reserved ColumnHeaders getObject()- returns a reference to this object
    DG_COLUMNHEADERS getObjectID()- gets the Object type. i.e. DG_COLUMNHEADERS
    DeepGrid getParent()- gets the parent Grid object
    Reserved row getRow()- gets the internal row object of the ColumnHeaders. Used Internally
    DeepGrid getTable()- see getParent()
    Reserved tHead getTHead()- gets the tHead of the table. Used Internally.
    Boolean isRaised()- gets the raised property of the ColumnHeader. The default is true
    void setAlignment(String Alignment)- sets the Alignment for the ColumnHeaders.
    void setBackgroundColor(String Color)- sets the background color of the ColumnHeaders. Note:Use DG_NOCOLOR for transparency.
    void setBackgroundImage(String Image)- sets the background image of the ColumnHeaders to the image specified by 'Image'.
    void setFont(String FontName, String FontStyle, Integer FontSize)- sets the font properties of the ColumnHeaders. 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 ColumnHeaders.
    void setFontSize(Integer FontSize)- sets the FontSize for the ColumnHeaders
    void setFontStyle(String FontStyle)- sets the FontStyle for the ColumnHeaders. 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 ColumnHeaders.
    void setRaised(Boolean Status)- toggles the raised property of the ColumnHeader
    [ Top ]
     
    Reserved : Property/Method that is intended to be used by the grid internally. Though accessor methods may be provided to these property/methods, their usage by the developer is not recommended and must be avaoided.
    ReadOnly : Property that is ReadOnly. Overwriting a Readonly Property may result in failure of the Grid
    Hosted by www.Geocities.ws

    1