CanvasMap
Getting Started Tutorials 3D Reference

Class CMDialog

CMDialog
Classes for creating modeless dialog boxes in the web site
Bootstrap is prefered for modal dialog boxes but these work better for
modeless.

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
.

Static Functions

ReturnsFunctionThrows
AddLabelToPanel(Text, XOffset, YPostion)
AddParagraphToPanel(Text, XOffset, YPostion, Width, Height)
AddColorControlToPanel(Name, XOffset, YPostion, Value)
AddButtonControlToPanel(Name, XOffset, YPostion)
AddSliderControlToPanel(Name, XOffset, YPostion, Min, Max, Value)
AddCheckBoxControlToPanel(Name, XOffset, YPostion, Value)
AddTextControlToPanel(Name, XOffset, YPostion, Value)
AddRadioControlToPanel(Name, XOffset, YPostion, Values, Selected)
AddSelectControlToPanel(Name, XOffset, YPostion, Values, Selected)
GetRGBAFromControls(FillColorControl, FillTransparencyControl)

Object Functions

ReturnsFunctionThrows
SetVisible(Text, XOffset, YPostion)
AddLabel(Text, XOffset, YPostion)
AddParagraph(Text, XOffset, YPostion, Width, Height)
AddColorControl(Name, XOffset, YPostion, Value)
AddButtonControl(Name, XOffset, YPostion)
AddSliderControl(Name, XOffset, YPostion, Min, Max, Value)
AddCheckBoxControl(Name, XOffset, YPostion, Value)
AddTextControl(Name, XOffset, YPostion, Value)
AddRadioControl(Name, XOffset, YPostion, Values, Selected)
AddSelectControl(Name, XOffset, YPostion, Values, Selected)

Static Functions

AddLabelToPanel(Text, XOffset, YPostion)

Adds a text label to the dialog

Parameters:
    Text - text that appears in the paragraph
    XOffset - X Position of the control in the dialog
    YPostion - Y Position of the control in the dialog

AddParagraphToPanel(Text, XOffset, YPostion, Width, Height)

Adds a paragraph of text to the dialog.

Parameters:
    Text - text that appears in the paragraph
    XOffset - X Position of the control in the dialog
    YPostion - Y Position of the control in the dialog
    Width - width of the paragraph
    Height - height of the paragraph

AddColorControlToPanel(Name, XOffset, YPostion, Value)

Creates a color control that displays a color picker

Parameters:
    Name - the name of the control
    XOffset - X Position of the control in the dialog
    YPostion - Y Position of the control in the dialog
    Value - Initial value

AddButtonControlToPanel(Name, XOffset, YPostion)

Creates a button with text in it.

Parameters:
    Name - the name of the control
    XOffset - X Position of the control in the dialog
    YPostion - Y Position of the control in the dialog

AddSliderControlToPanel(Name, XOffset, YPostion, Min, Max, Value)

Function to create a slider control

Parameters:
    Name - the name of the control
    XOffset - X Position of the control in the dialog
    YPostion - Y Position of the control in the dialog
    Min - minimum value for the contorl (i.e. left side)
    Max - maximum value for the control (i.e. right side)
    Value - initial value for the control

AddCheckBoxControlToPanel(Name, XOffset, YPostion, Value)

Function to create a check box control

Parameters:
    Name - the name of the control
    XOffset - X Position of the control in the dialog
    YPostion - Y Position of the control in the dialog
    Value - true or false initial state of the checkbox

AddTextControlToPanel(Name, XOffset, YPostion, Value)

Function to create a text edit control

Parameters:
    Name - the name of the control
    XOffset - X Position of the control in the dialog
    YPostion - Y Position of the control in the dialog
    Value - initial contents of the control

AddRadioControlToPanel(Name, XOffset, YPostion, Values, Selected)

Function to create a group of radio buttons.

To determine which buttons is pressed, you will need to go through the returned array
and see which value is "checked" (i.e. Result[i].checked=true).

Parameters:
    Name - the name of the control
    XOffset - X Position of the control in the dialog
    YPostion - Y Position of the control in the dialog
    Values - array of values for the radio buttons. These will be the names of the
    Selected - the selected value from values or "null" for none

AddSelectControlToPanel(Name, XOffset, YPostion, Values, Selected)

Function to create a select (popup menu) control

Parameters:
    Name - the name of the control
    XOffset - X Position of the control in the dialog
    YPostion - Y Position of the control in the dialog
    Values - array of values for the radio buttons. These will be the names of the
    Selected - the selected value from values or "null" for none

GetRGBAFromControls(FillColorControl, FillTransparencyControl)

Returns the value from a color control and a transparency control as an RGBA HTML color

Parameters:
    FillColorControl - the color control
    FillTransparencyControl - the slider control for transparency

Object Functions

SetVisible(Text, XOffset, YPostion)

Makes the dialog visible or invisible

Parameters:
    Text - text that appears in the paragraph
    XOffset - X Position of the control in the dialog
    YPostion - Y Position of the control in the dialog

AddLabel(Text, XOffset, YPostion)

Adds a text label to the dialog

Parameters:
    Text - text that appears in the paragraph
    XOffset - X Position of the control in the dialog
    YPostion - Y Position of the control in the dialog

AddParagraph(Text, XOffset, YPostion, Width, Height)

Adds a paragraph of text to the dialog.

Parameters:
    Text - text that appears in the paragraph
    XOffset - X Position of the control in the dialog
    YPostion - Y Position of the control in the dialog
    Width - width of the paragraph
    Height - height of the paragraph

AddColorControl(Name, XOffset, YPostion, Value)

Creates a color control that displays a color picker

Parameters:
    Name - the name of the control
    XOffset - X Position of the control in the dialog
    YPostion - Y Position of the control in the dialog
    Value - Initial value

AddButtonControl(Name, XOffset, YPostion)

Creates a button with text in it.

Parameters:
    Name - the name of the control
    XOffset - X Position of the control in the dialog
    YPostion - Y Position of the control in the dialog

AddSliderControl(Name, XOffset, YPostion, Min, Max, Value)

Function to create a slider control

Parameters:
    Name - the name of the control
    XOffset - X Position of the control in the dialog
    YPostion - Y Position of the control in the dialog
    Min - minimum value for the contorl (i.e. left side)
    Max - maximum value for the control (i.e. right side)
    Value - initial value for the control

AddCheckBoxControl(Name, XOffset, YPostion, Value)

Function to create a check box control

Parameters:
    Name - the name of the control
    XOffset - X Position of the control in the dialog
    YPostion - Y Position of the control in the dialog
    Value - true or false initial state of the checkbox

AddTextControl(Name, XOffset, YPostion, Value)

Function to create a text edit control

Parameters:
    Name - the name of the control
    XOffset - X Position of the control in the dialog
    YPostion - Y Position of the control in the dialog
    Value - initial contents of the control

AddRadioControl(Name, XOffset, YPostion, Values, Selected)

Function to create a group of radio buttons.

To determine which buttons is pressed, you will need to go through the returned array
and see which value is "checked" (i.e. Result[i].checked=true).

Parameters:
    Name - the name of the control
    XOffset - X Position of the control in the dialog
    YPostion - Y Position of the control in the dialog
    Values - array of values for the radio buttons. These will be the names of the
    Selected - the selected value from values or "null" for none

AddSelectControl(Name, XOffset, YPostion, Values, Selected)

Function to create a select (popup menu) control

Parameters:
    Name - the name of the control
    XOffset - X Position of the control in the dialog
    YPostion - Y Position of the control in the dialog
    Values - array of values for the radio buttons. These will be the names of the
    Selected - the selected value from values or "null" for none