com.rednels.ofcgwt.client.model.Legend.java Source code

Introduction

Here is the source code for com.rednels.ofcgwt.client.model.Legend.java

Source

/*
Copyright (C) 2009 Grant Slender
    
This file is part of OFCGWT.
http://code.google.com/p/ofcgwt/
    
OFCGWT is free software: you can redistribute it and/or modify
it under the terms of the Lesser GNU General Public License as
published by the Free Software Foundation, either version 3 of
the License, or (at your option) any later version.
    
OFCGWT is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.
    
See <http://www.gnu.org/licenses/lgpl-3.0.txt>.
 */
package com.rednels.ofcgwt.client.model;

import com.google.gwt.json.client.JSONBoolean;
import com.google.gwt.json.client.JSONNumber;
import com.google.gwt.json.client.JSONObject;
import com.google.gwt.json.client.JSONString;
import com.google.gwt.json.client.JSONValue;

/**
 * Base class for an OFC legend element
 */
public class Legend implements JSONizable {
    /**
     * Enumeration Position - used with legend.
     */
    public static enum Position {

        /** CLOSEST */
        TOP("top"),

        /** FOLLOW */
        RIGHT("right");

        /** The pos. */
        private String pos;

        /**
         * Creates a new bar style.
         * 
         * @param pos
         *            the pos
         */
        Position(String pos) {
            this.pos = pos;
        }

        /**
         * Gets the pos.
         * 
         * @return the pos
         */
        public String getString() {
            return pos;
        }
    }

    private Position position;
    private boolean border;
    private Integer stroke;
    private boolean shadow = true;
    private String borderColour;
    private String bgColour;
    private Float alpha;
    private Integer margin;

    private Integer padding;

    /**
     * Create a new Legend instance with the given position and border.
     * 
     * @param pos
     *            Position
     * @param border
     *            boolean
     */
    public Legend(Position pos, boolean border) {
        setPosition(pos);
        setBorder(border);
    }

    /*
     * (non-Javadoc)
     * 
     * @see com.rednels.ofcgwt.client.model.JSONizable.buildJSON()
     */
    public JSONValue buildJSON() {
        JSONObject json = new JSONObject();
        json.put("visible", JSONBoolean.getInstance(true));
        json.put("bg_colour", new JSONString("#fefefe"));
        if (position != null)
            json.put("position", new JSONString(position.getString()));
        json.put("border", JSONBoolean.getInstance(border));
        json.put("shadow", JSONBoolean.getInstance(shadow));
        if (alpha != null)
            json.put("alpha", new JSONNumber(alpha));
        if (stroke != null)
            json.put("stroke", new JSONNumber(stroke));
        if (margin != null)
            json.put("margin", new JSONNumber(margin));
        if (padding != null)
            json.put("padding", new JSONNumber(padding));
        if (borderColour != null)
            json.put("border_colour", new JSONString(borderColour));
        if (bgColour != null)
            json.put("bg_colour", new JSONString(bgColour));
        return json;
    }

    /**
     * @return the alpha
     */
    public Float getAlpha() {
        return alpha;
    }

    /**
     * @return the bgColour
     */
    public String getBgColour() {
        return bgColour;
    }

    /**
     * Get the border
     * 
     * @return true if border is enabled
     */
    public boolean getBorder() {
        return border;
    }

    /**
     * @return the borderColour
     */
    public String getBorderColour() {
        return borderColour;
    }

    /**
     * @return the margin
     */
    public Integer getMargin() {
        return margin;
    }

    /**
     * @return the padding
     */
    public Integer getPadding() {
        return padding;
    }

    /**
     * Get the position
     * 
     * @return Position pos
     */
    public Position getPosition() {
        return position;
    }

    /**
     * @return the stroke
     */
    public Integer getStroke() {
        return stroke;
    }

    /**
     * @return the shadow
     */
    public boolean isShadow() {
        return shadow;
    }

    /**
     * @param alpha
     *            the alpha to set
     */
    public void setAlpha(Float alpha) {
        this.alpha = alpha;
    }

    /**
     * @param bgColour
     *            the bgColour to set
     */
    public void setBgColour(String bgColour) {
        this.bgColour = bgColour;
    }

    /**
     * Sets the border, whether or not to draw a line around the side legend.
     * 
     * @param border
     *            boolean
     */
    public void setBorder(boolean border) {
        this.border = border;
    }

    /**
     * @param borderColour
     *            the borderColour to set
     */
    public void setBorderColour(String borderColour) {
        this.borderColour = borderColour;
    }

    /**
     * @param margin
     *            the margin to set
     */
    public void setMargin(Integer margin) {
        this.margin = margin;
    }

    /**
     * @param padding
     *            the padding to set
     */
    public void setPadding(Integer padding) {
        this.padding = padding;
    }

    /**
     * Sets the position.
     * 
     * @param pos
     *            Position
     */
    public void setPosition(Position pos) {
        this.position = pos;
    }

    /**
     * @param shadow
     *            the shadow to set
     */
    public void setShadow(boolean shadow) {
        this.shadow = shadow;
    }

    /**
     * @param stroke
     *            the stroke to set
     */
    public void setStroke(Integer stroke) {
        this.stroke = stroke;
    }
}