Class: Google::Apis::CloudsearchV1::AppsDynamiteSharedDecoratedText

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/cloudsearch_v1/classes.rb,
lib/google/apis/cloudsearch_v1/representations.rb,
lib/google/apis/cloudsearch_v1/representations.rb

Overview

A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget or a button after the text.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ AppsDynamiteSharedDecoratedText

Returns a new instance of AppsDynamiteSharedDecoratedText.



2130
2131
2132
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2130

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#bottom_label ⇒ String

The formatted text label that shows below the main text. Corresponds to the JSON property bottomLabel

Returns:

  • (String) 


2081
2082
2083
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2081

def bottom_label
  @bottom_label
end

#button ⇒ Google::Apis::CloudsearchV1::AppsDynamiteSharedButton

A button. Can be a text button or an image button. Corresponds to the JSON property button

Returns:



2086
2087
2088
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2086

def button
  @button
end

#end_icon ⇒ Google::Apis::CloudsearchV1::AppsDynamiteSharedIcon

An icon displayed after the text. Corresponds to the JSON property endIcon

Returns:



2091
2092
2093
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2091

def end_icon
  @end_icon
end

#icon ⇒ Google::Apis::CloudsearchV1::AppsDynamiteSharedIcon

Deprecated in favor of start_icon. Corresponds to the JSON property icon

Returns:



2096
2097
2098
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2096

def icon
  @icon
end

#on_click ⇒ Google::Apis::CloudsearchV1::AppsDynamiteSharedOnClick

Only the top and bottom label and content region are clickable. Corresponds to the JSON property onClick

Returns:



2101
2102
2103
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2101

def on_click
  @on_click
end

#start_icon ⇒ Google::Apis::CloudsearchV1::AppsDynamiteSharedIcon

The icon displayed in front of the text. Corresponds to the JSON property startIcon

Returns:



2106
2107
2108
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2106

def start_icon
  @start_icon
end

#switch_control ⇒ Google::Apis::CloudsearchV1::AppsDynamiteSharedDecoratedTextSwitchControl

A switch widget can be clicked to change its state or trigger an action. Corresponds to the JSON property switchControl

Returns:



2111
2112
2113
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2111

def switch_control
  @switch_control
end

#text ⇒ String

Required. The main widget formatted text. See Text formatting for details. Corresponds to the JSON property text

Returns:

  • (String) 


2116
2117
2118
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2116

def text
  @text
end

#top_label ⇒ String

The formatted text label that shows above the main text. Corresponds to the JSON property topLabel

Returns:

  • (String) 


2121
2122
2123
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2121

def top_label
  @top_label
end

#wrap_text ⇒ Boolean Also known as: wrap_text?

The wrap text setting. If true, the text is wrapped and displayed in multiline. Otherwise, the text is truncated. Corresponds to the JSON property wrapText

Returns:

  • (Boolean) 


2127
2128
2129
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2127

def wrap_text
  @wrap_text
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2135

def update!(**args)
  @bottom_label = args[:bottom_label] if args.key?(:bottom_label)
  @button = args[:button] if args.key?(:button)
  @end_icon = args[:end_icon] if args.key?(:end_icon)
  @icon = args[:icon] if args.key?(:icon)
  @on_click = args[:on_click] if args.key?(:on_click)
  @start_icon = args[:start_icon] if args.key?(:start_icon)
  @switch_control = args[:switch_control] if args.key?(:switch_control)
  @text = args[:text] if args.key?(:text)
  @top_label = args[:top_label] if args.key?(:top_label)
  @wrap_text = args[:wrap_text] if args.key?(:wrap_text)
end