Class Switch

전환

전환 켜기 또는 끄기를 지원하는 UI 요소입니다. DecoratedText 위젯 내에서만 사용할 수 있습니다.

var switchDecoratedText  = CardService.newDecoratedText()
  .setTopLabel("Switch decorated text widget label")
  .setText("This is a decorated text widget with a switch on the right")
  .setWrapText(true)
  .setSwitchControl(CardService.newSwitch()
      .setFieldName("form_input_switch_key")
      .setValue("form_input_switch_value")
      .setOnChangeAction(CardService.newAction()
          .setFunctionName("handleSwitchChange")));

메서드

메서드반환 유형간략한 설명
setControlType(controlType)Switch스위치의 제어 유형을 설정합니다.
setFieldName(fieldName)SwitchUI 상호작용이 있을 때 생성되는 이벤트 객체에서 이 스위치를 식별하는 키를 설정합니다.
setOnChangeAction(action)Switch스위치가 전환될 때 실행할 작업을 설정합니다.
setSelected(selected)Switch이 스위치를 선택된 상태로 시작할지, 아니면 선택 해제할지 설정합니다.
setValue(value)Switch이 스위치가 사용으로 전환되었을 때 양식 입력으로 전송되는 값을 설정합니다.

자세한 문서

setControlType(controlType)

스위치의 제어 유형을 설정합니다. 기본값은 SWITCH입니다.

매개변수

이름유형설명
controlTypeSwitchControlType스위치 제어 유형입니다.

Return

Switch: 체이닝을 위한 이 객체입니다.


setFieldName(fieldName)

UI 상호작용이 있을 때 생성되는 이벤트 객체에서 이 스위치를 식별하는 키를 설정합니다. 사용자에게 표시되지 않습니다. 필수 항목입니다.

다른 양식 필드와 달리 이 필드 이름은 고유할 필요가 없습니다. 동일한 필드 이름을 사용하는 스위치의 양식 입력 값은 배열로 반환됩니다. 배열은 해당 필드 이름을 사용하는 사용 설정된 모든 스위치의 값으로 구성됩니다.

매개변수

이름유형설명
fieldNameString이 스위치를 식별하는 데 사용되는 키입니다.

Return

Switch: 체이닝을 위한 이 객체입니다.


setOnChangeAction(action)

스위치가 전환될 때 실행할 작업을 설정합니다.

매개변수

이름유형설명
actionAction스위치가 전환될 때 실행할 작업입니다.

Return

Switch: 체이닝을 위한 이 객체입니다.


setSelected(selected)

이 스위치를 선택된 상태로 시작할지, 아니면 선택 해제할지 설정합니다.

매개변수

이름유형설명
selectedBoolean시작 스위치 상태 설정

Return

Switch: 체이닝을 위한 이 객체입니다.


setValue(value)

이 스위치가 사용으로 전환되었을 때 양식 입력으로 전송되는 값을 설정합니다.

매개변수

이름유형설명
valueString스위치가 켜져 있을 때 이름과 연결된 값입니다. 양식 콜백에 전송될 때 항상 문자열로 표시됩니다.

Return

Switch: 체이닝을 위한 이 객체입니다.