CanvasMap
Getting Started Tutorials 3D Reference

Class CMPanelButtons extends CMPanel

CMPanelButtons


Copyright (C) 2020, Humboldt State University, Jim Graham

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General
Public License as published by the Free Software Foundation, either version 3 of the License, or (at your
option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the
implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see
.

Settings Group: Panel

Setting Name Type Options Default Comments
Width Width CMTYPE_FLOAT CMPANELBUTTONS_WIDTH

ButtonContentClassName Button Content Class Name CMTYPE_STRING CM_ButtonContent

Object Functions

Inherited From: CMPanel
ReturnsFunctionThrows
Thecontent AddButtonAndContentPanel(ContentID, Name, ToolTip)
The AddButton(ContentID, Name, ToolTip)
SelectButton(ContentID)
GetTabContentElement(TabName)
RemoveButton(TabName)

Object Functions

Thecontent=AddButtonAndContentPanel(ContentID, Name, ToolTip)

Add a tab to the tab panel.

Parameters:
    ContentID - The id for the content that will be associated with the tab.
    Name - The name that will appear in the tabs
    ToolTip - Optional tools tip that will appear when the user hovers over the tab.

Returns: Thecontent - assocaited with the button.

The=AddButton(ContentID, Name, ToolTip)

Add a tab to the tab panel.

Parameters:
    ContentID - The id for the content that will be associated with the tab.
    Name - The name that will appear in the tabs
    ToolTip - Optional tools tip that will appear when the user hovers over the tab.

Returns: The - tab content assocaited with the tab.

SelectButton(ContentID)

Set the currently selected button

Parameters:
    ContentID - The DOM id of the button to select. -1 to unselect all buttons.

GetTabContentElement(TabName)

Returns a tab content element so it can be filled

Parameters:
    TabName - name of the tab whose content will be returned

RemoveButton(TabName)

Removes a table from tab container

Parameters:
    TabName - name of the tab whose content will be returned