package org.openntf.domino.nsfdata.structs.cd;

import java.util.EnumSet;
import java.util.Set;

import org.openntf.domino.nsfdata.structs.BSIG;
import org.openntf.domino.nsfdata.structs.FONTID;
import org.openntf.domino.nsfdata.structs.SIG;

/**
 * The designer of a form or view may define custom actions for that form or view. The attributes for the button bar are stored in the
 * CDACTIONBAR record in the $ACTIONS and/or $V5ACTIONS item for the design note describing the form or view. (actods.h)
 * 
 * @since Lotus Notes/Domino 4.5
 */
public class CDACTIONBAR extends CDRecord {
	public static enum ActionLineStyle {
		UNDEFINED, SINGLE, DOUBLE, TRIPLE, TWO
	}

	public static enum ActionBorderStyle {
		/**
		 * No border selected
		 */
		NONE,
		/**
		 * Maximum border selected within window size
		 */
		MAX,
		/**
		 * Border under buttons only
		 */
		VAR,
		/**
		 * Border calculated with Border Width
		 */
		ABS
	}

	public static enum Flag {
		NO_SYS_COLOR(0x00000001),
		/**
		 * Right justify buttons
		 */
		ALIGN_RIGHT(0x00000002),
		/**
		 * Buttons are transparent
		 */
		TRANS_BUTTONS(0x00000004),
		/**
		 * Buttons use system color
		 */
		SYS_BUTTONS(0x00000008),
		/**
		 * Image resource used for button background
		 */
		BTNBCK_IMGRSRC(0x00000010),
		/**
		 * Image resource used for bar background
		 */
		BARBCK_IMGRSRC(0x00000020),
		/**
		 * Use the Padding setting instead of default 2 pixels
		 */
		SET_PADDING(0x00000040),
		/**
		 * Use applet in browser
		 */
		USE_APPLET(0x00000080),
		/**
		 * Use Height setting instead of default ICON_DEFAULT_HEIGHT
		 */
		SET_HEIGHT(0x00000100),
		/**
		 * if ACTION_BAR_FLAG_SET_HEIGHT, use absolute height spec'd by user
		 */
		ABSOLUTE_HEIGHT(0x00000200),
		/**
		 * if ACTION_BAR_FLAG_SET_HEIGHT, use background image's height
		 */
		BACKGROUND_HEIGHT(0x00000400),
		/**
		 * Use Width setting instead of default width
		 */
		SET_WIDTH(0x00000800),
		/**
		 * if ACTION_BAR_FLAG_SET_WIDTH, use background image's width
		 */
		BACKGROUND_WIDTH(0x00001000),
		/**
		 * Always show the drop down hinky if a button has a menu no matter what the border style is
		 */
		SHOW_HINKY_ALWAYS(0x00002000),
		/**
		 * suppress the system actions in the right click pop-up (views only)
		 */
		SUPPRESS_SYS_POPUPS(0x00004000),
		/**
		 * use a JS (dojo) control to render the action bar on the web
		 * 
		 * @since IBM Lotus Notes/Domino 8.5.0
		 */
		USE_JSCONTROL(0x00008000),
		/**
		 * use a custom js control to render the action bar on the web
		 * 
		 * @since IBM Lotus Notes/Domino 8.5.0
		 */
		USE_CUSTOMJS(0x00010000);

		private final int value_;

		private Flag(final int value) {
			value_ = value;
		}

		public int getValue() {
			return value_;
		}

		public static Set<Flag> valuesOf(final int flags) {
			Set<Flag> result = EnumSet.noneOf(Flag.class);
			for (Flag flag : values()) {
				if ((flag.getValue() & flags) > 0) {
					result.add(flag);
				}
			}
			return result;
		}
	}

	public final BSIG Header = inner(new BSIG());
	public final Unsigned16 BackColor = new Unsigned16();
	public final Unsigned16 LineColor = new Unsigned16();
	public final Enum16<ActionLineStyle> LineStyle = new Enum16<ActionLineStyle>(ActionLineStyle.values());
	public final Enum16<ActionBorderStyle> BorderStyle = new Enum16<ActionBorderStyle>(ActionBorderStyle.values());
	public final Unsigned16 BorderWidth = new Unsigned16();
	/**
	 * Use getFlags for access.
	 */
	@Deprecated
	public final Unsigned32 dwFlags = new Unsigned32();
	public final Unsigned32 ShareID = new Unsigned32();
	public final FONTID FontID = inner(new FONTID());
	public final Unsigned16 BtnHeight = new Unsigned16();
	public final Unsigned16 HeightSpc = new Unsigned16();

	@Override
	public SIG getHeader() {
		return Header;
	}

	public Set<Flag> getFlags() {
		return Flag.valuesOf((int) dwFlags.get());
	}
}