com.google.blockly.model.FieldImage.java Source code

Introduction

Here is the source code for com.google.blockly.model.FieldImage.java

Source

/*
 * Copyright 2016 Google Inc. All Rights Reserved.
 * 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.
 */

package com.google.blockly.model;

import android.text.TextUtils;

import org.json.JSONObject;

/**
 * Adds an image to an Input.
 */
public final class FieldImage extends Field {
    private String mSrc;
    private int mWidth;
    private int mHeight;
    private String mAltText;

    public FieldImage(String name, String src, int width, int height, String altText) {
        super(name, TYPE_IMAGE);
        mSrc = src;
        mWidth = width;
        mHeight = height;
        mAltText = altText;
    }

    public static FieldImage fromJson(JSONObject json) {
        return new FieldImage(json.optString("name"),
                json.optString("src", "https://www.gstatic.com/codesite/ph/images/star_on.gif"),
                json.optInt("width", 15), json.optInt("height", 15), json.optString("alt", "*"));
    }

    @Override
    public FieldImage clone() {
        return new FieldImage(getName(), mSrc, mWidth, mHeight, mAltText);
    }

    /**
     * @return The source for the image.
     */
    public String getSource() {
        return mSrc;
    }

    /**
     * @return The display width of the image in dips.
     */
    public int getWidth() {
        return mWidth;
    }

    /**
     * @return The display height of the image in dips.
     */
    public int getHeight() {
        return mHeight;
    }

    /**
     * @return The alt-text for the image.
     */
    public String getAltText() {
        return mAltText;
    }

    /**
     * Sets the alt-text for the image.
     */
    public void setAltText(String altText) {
        mAltText = altText;
    }

    /**
     * Sets a new image to be shown.
     * <p/>
     * Changes will induce a {@link Field.Observer#onValueChanged}, even though FieldImages do not
     * store a value.  This trigger updates to the matching Fieldview, but in might also generate a
     * no-op {@link com.google.blockly.android.control.BlocklyEvent.ChangeEvent}.
     *
     * @param src A web address or Blockly reference to the image.
     * @param width The display width of the image in dips.
     * @param height The display height of the image in dips.
     */
    public void setImage(String src, int width, int height) {
        if (!TextUtils.equals(mSrc, src) || mWidth != width || mHeight != height) {
            mSrc = src;
            mWidth = width;
            mHeight = height;

            fireValueChanged("", "");
        }
    }

    @Override
    public boolean setFromString(String text) {
        throw new IllegalStateException("Image field cannot be set from string.");
    }

    @Override
    public String getSerializedValue() {
        return ""; // Image fields do not have value.
    }
}