com.smartsheet.api.models.WidgetContent Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of smartsheet-sdk-java Show documentation
Library for connecting to Smartsheet Services
There is a newer version: 3.2.0
package com.smartsheet.api.models;

import java.util.List;

/*
 * #[license]
 * Smartsheet SDK for Java
 * %%
 * Copyright (C) 2014 Smartsheet
 * %%
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * %[license]
 */

public class WidgetContent {
	/**
	 * Represents the CellLinkWidgetContent object
	 */
	private Link hyperlink;
	private List cellData;
	private List column;
	
	/**
	 * Represents the RichTextWidgetContent object.
	 */
	private String html;
	
	/**
	 * Represents the ShortcutWidgetContent object.
	 */
	private List shortcutData;
	
	/**
	 * Represents the ReportWidgetContent object.
	 */
	private String htmlContent;
	
	/**
	 * Represents the ImageWidgetContent object.
	 */
	private String privateId;
	private Integer height;
	private Integer width;
	private String fileName;
	private String format;
	
	/**
	 * Get "when clicked" hyperlink
	 * 
	 * @return hyperlink
	 */
	public Link getHyperlink() {
		return hyperlink;
	}
	
	/**
	 * Set "when clicked" hyperlink
	 *
	 * @param hyperlink
	 */
	public WidgetContent setHyperlink(Link hyperlink) {
		this.hyperlink = hyperlink;
		return this;
	}
	
	/**
	 * Get array of cell data
	 * 
	 * @return cellData
	 */
	public List getCellData() {
		return cellData;
	}
	
	/**
	 * Set array of cell data
	 *
	 * @param cellData
	 */
	public WidgetContent setCellData(List cellData) {
		this.cellData = cellData;
		return this;
	}
	
	/**
	 * Get array of column objects
	 * 
	 * @return column
	 */
	public List getColumn() {
		return column;
	}
	
	/**
	 * Set array of column objects
	 *
	 * @param column
	 */
	public WidgetContent setColumn(List column) {
		this.column = column;
		return this;
	}
	
	/**
	 * Get widget content as HTML
	 * 
	 * @return html
	 */
	public String getHtml() {
		return html;
	}
	
	/**
	 * Set widget content as HTML
	 *
	 * @param html
	 */
	public WidgetContent setHtml(String html) {
		this.html = html;
		return this;
	}
	
	/**
	 * Get array of ShortcutDataItem objects.
	 * 
	 * @return shortcutData
	 */
	public List getShortcutData() {
		return shortcutData;
	}
	
	/**
	 * Set the array of ShortcutDataItems 
	 *
	 * @param shortcutData
	 */
	public WidgetContent setShortcutData(List shortcutData) {
		this.shortcutData = shortcutData;
		return this;
	}
	
	/**
	 * Get HTML snippet to render Report
	 * 
	 * @return htmlContent
	 */
	public String getHtmlContent() {
		return htmlContent;
	}
	
	/** 
	 * Set HTML snippet to render Report
	 *
	 * @param htmlContent
	 */
	public WidgetContent setHtmlContent(String htmlContent) {
		this.htmlContent = htmlContent;
		return this;
	}
	
	/**
	 * Get the image private Id
	 * 
	 * @return privateId
	 */
	public String getPrivateId() {
		return privateId;
	}
	
	/**
	 * Set the image private Id
	 *
	 * @param privateId
	 */
	public WidgetContent setPrivateId(String privateId) {
		this.privateId = privateId;
		return this;
	}
	
	/**
	 * Get the original height of the image in pixels
	 * 
	 * @return height
	 */
	public Integer getHeight() {
		return height;
	}
	
	/**
	 * Set the original height of the image in pixels
	 *
	 * @param height
	 */
	public WidgetContent setHeight(Integer height) {
		this.height = height;
		return this;
	}
	
	/**
	 * Get the original width of the image in pixels
	 * 
	 * @return width
	 */
	public Integer getWidth() {
		return width;
	}
	
	/**
	 * Set the original width of the image in pixels
	 *
	 * @param width
	 */
	public WidgetContent setWidth(Integer width) {
		this.width = width;
		return this;
	}
	
	/**
	 * Get the file name of the image file
	 * 
	 * @return fileName
	 */
	public String getFileName() {
		return fileName;
	}
	
	/**
	 * Set the file name of the image file
	 *
	 * @param fileName
	 */
	public WidgetContent setFileName(String fileName) {
		this.fileName = fileName;
		return this;
	}
	
	/**
	 * Get the format descriptor of the image
	 * 
	 * @return format
	 */
	public String getFormat() {
		return format;
	}
	
	/**
	 * Set the format descriptor of the image
	 *
	 * @param format
	 */
	public WidgetContent setFormat(String format) {
		this.format = format;
		return this;
	}
}