/**************************************************************
 * 
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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 org.openoffice.test.vcl.widgets;

import java.awt.Point;

import org.openoffice.test.vcl.client.Constant;

/**
 * Proxy to access a VCL window.
 *
 */
public class VclWindow extends VclControl {
	
	public VclWindow(VclApp app, String id) {
		super(app, id);
	}


	/**
	 * Get the title of the window
	 * @return
	 */
	public String getText() {
		return getCaption();
	}
	
	/**
	 * Presses the Help button to open the help topic for the window
	 * 
	 */
	public void help()  {
		invoke(Constant.M_Help);
	}
	
	/**
	 * Closes a window with the Close button.
	 */
	public void close() {
		invoke(Constant.M_Close);
	}
	
	/**
	 * Move the window by percent
	 * 
	 * @param x
	 * @param y
	 */
	public void move(int x, int y)  {
		invoke(Constant.M_Move, new Object[]{new Integer(x), new Integer(y)});
	}

	/**
	 * Move the window by pixel
	 * @param p
	 */
	public void move(Point p) {
		move(p.x, p.y);
	}
	
	
	
	/**
	 * Returns the state of the window (maximize or minimize).
	 * <p>
	 * 
	 * @return Returns TRUE if the window is maximized, otherwise FALSE is
	 *         returned.
	 */
	public boolean isMax() {
		return (Boolean)invoke(Constant.M_IsMax);
	}

	/**
	 * Maximizes a window so that the contents of the window are visible.
	 */
	public void maximize() {
		invoke(Constant.M_Maximize);
	}

	/**
	 * Minimizes a window so that only the title bar of the window is visible
	 */
	public void minimize() {
		invoke(Constant.M_Minimize);
	}


	/**
	 * Resize the window
	 * @param x
	 * @param y
	 */
	public void resize(int x, int y) {
		invoke(Constant.M_Size, new Object[]{new Integer(x), new Integer(y)});
	}
	
	/**
	 * Restore the window
	 *
	 */
	public void restore() {
		invoke(Constant.M_Restore);
	}

	/**
	 * Activate the window
	 */
	public void activate() {
		// focus it
		focus();
	}
}