AndroidViewComponent.java

Go to the documentation of this file.

// -*- mode: java; c-basic-offset: 2; -*-
// Copyright 2009-2011 Google, All Rights reserved
// Copyright 2011-2017 MIT, All rights reserved
// Released under the Apache License, Version 2.0
// http://www.apache.org/licenses/LICENSE-2.0
 
package com.google.appinventor.components.runtime;
 
import com.google.appinventor.components.annotations.DesignerProperty;
import com.google.appinventor.components.annotations.PropertyCategory;
import com.google.appinventor.components.annotations.SimpleObject;
import com.google.appinventor.components.annotations.SimpleProperty;
import com.google.appinventor.components.annotations.SimplePropertyCopier;
import com.google.appinventor.components.common.ComponentConstants;
import com.google.appinventor.components.common.PropertyTypeConstants;
import com.google.appinventor.components.runtime.util.ErrorMessages;
 
import android.view.View;
 
@SimpleObject
public abstract class AndroidViewComponent extends VisibleComponent {
 
  protected final ComponentContainer container;
 
  private int percentWidthHolder = LENGTH_UNKNOWN;
  private int percentHeightHolder = LENGTH_UNKNOWN;
  private int lastSetWidth = LENGTH_UNKNOWN;
  private int lastSetHeight = LENGTH_UNKNOWN;
 
  private int column = ComponentConstants.DEFAULT_ROW_COLUMN;
  private int row = ComponentConstants.DEFAULT_ROW_COLUMN;
 
  protected AndroidViewComponent(ComponentContainer container) {
    this.container = container;
  }
 
  public abstract View getView();
 
  @SimpleProperty(
      description = "Specifies whether the %type% should be visible on the screen. "
          + "Value is true if the %type% is showing and false if hidden.",
      category = PropertyCategory.APPEARANCE)
  public boolean Visible() {
    return getView().getVisibility() == View.VISIBLE;
  }
 
  @DesignerProperty(editorType = PropertyTypeConstants.PROPERTY_TYPE_VISIBILITY,
      defaultValue = "True")
  @SimpleProperty
  public void Visible(boolean visibility) {
    // The principle of least astonishment suggests we not offer the
    // Android option INVISIBLE.
    getView().setVisibility(visibility ? View.VISIBLE : View.GONE);
  }
 
  @Override
  @SimpleProperty
  public int Width() {
    int zWidth = (int)(getView().getWidth() / container.$form().deviceDensity());
//    System.err.println("AndroidViewComponent: Width() Called, returning " + zWidth);
    return zWidth;
  }
 
  @Override
  @SimpleProperty(description = "Specifies the horizontal width of the %type%, measured in pixels.")
  public void Width(int width) {
    container.setChildWidth(this, width);
    lastSetWidth = width;
    if (width <= Component.LENGTH_PERCENT_TAG) {
      container.$form().registerPercentLength(this, width, Form.PercentStorageRecord.Dim.WIDTH);
    } else {
      container.$form().unregisterPercentLength(this, Form.PercentStorageRecord.Dim.WIDTH);
    }
  }
 
  @Override
  @SimpleProperty(description = "Specifies the horizontal width of the %type% as a percentage of "
      + "the width of the Screen.")
  public void WidthPercent(int pCent) {
    if (pCent < 0 || pCent > 100) {
      container.$form().dispatchErrorOccurredEvent(this, "WidthPercent",
        ErrorMessages.ERROR_BAD_PERCENT, pCent);
      return;
    }
    int v = -pCent + Component.LENGTH_PERCENT_TAG;
    Width(v);
  }
 
  public void setLastWidth(int width) {
//    System.err.println(this + " percentWidthHolder being set to " + width);
    percentWidthHolder = width;
  }
 
  public int getSetWidth() {
//    System.err.println(this + " getSetWidth() percentWidthHolder = " + percentWidthHolder);
    if (percentWidthHolder == LENGTH_UNKNOWN) {
      return Width();           // best guess...
    } else {
      return percentWidthHolder;
    }
  }
 
  public void setLastHeight(int height) {
//    System.err.println(this + " percentHeightHolder being set to " + height);
    percentHeightHolder = height;
  }
 
  public int getSetHeight() {
//    System.err.println(this + " getSetHeight() percentHeightHolder = " + percentHeightHolder);
    if (percentHeightHolder == LENGTH_UNKNOWN) {
      return Height();           // best guess...
    } else {
      return percentHeightHolder;
    }
  }
 
  @SimplePropertyCopier
  public void CopyWidth(AndroidViewComponent sourceComponent) {
    Width(sourceComponent.lastSetWidth);
  }
 
  @Override
  @SimpleProperty
  public int Height() {
    return (int)(getView().getHeight() / container.$form().deviceDensity());
  }
 
  @Override
  @SimpleProperty(description = "Specifies the vertical height of the %type%, measured in pixels.")
  public void Height(int height) {
    container.setChildHeight(this, height);
    lastSetHeight = height;
    if (height <= Component.LENGTH_PERCENT_TAG) {
      container.$form().registerPercentLength(this, height, Form.PercentStorageRecord.Dim.HEIGHT);
    } else {
      container.$form().unregisterPercentLength(this, Form.PercentStorageRecord.Dim.HEIGHT);
    }
  }
 
  @Override
  @SimpleProperty(description = "Specifies the vertical height of the %type% as a percentage of "
      + "the height of the Screen.")
  public void HeightPercent(int pCent) {
    if (pCent < 0 || pCent > 100) {
      container.$form().dispatchErrorOccurredEvent(this, "HeightPercent",
        ErrorMessages.ERROR_BAD_PERCENT, pCent);
      return;
    }
    int v = -pCent + Component.LENGTH_PERCENT_TAG;
    Height(v);
  }
 
  @SimplePropertyCopier
  public void CopyHeight(AndroidViewComponent sourceComponent) {
    Height(sourceComponent.lastSetHeight);
  }
 
  @SimpleProperty(userVisible = false)
  public int Column() {
    return column;
  }
 
  @SimpleProperty(userVisible = false)
  public void Column(int column) {
    this.column = column;
  }
 
  @SimpleProperty(userVisible = false)
  public int Row() {
    return row;
  }
 
  @SimpleProperty(userVisible = false)
  public void Row(int row) {
    this.row = row;
  }
 
  // Component implementation
 
  @Override
  public HandlesEventDispatching getDispatchDelegate() {
    return container.$form();
  }
}