WebBrowserManager.java
/*
** Module : WebBrowserManager.java
** Abstract : Opens a browser to display the target page.
**
** Copyright (c) 2016-2021, Golden Code Development Corporation.
**
** -#- -I- --Date-- --------------------------------Description-----------------------------------
** 001 SBI 20160411 Created initial version.
** 002 SBI 20180402 Added openMimeResource.
** 003 ECF 20180510 Added API variants to handle additional combinations of parameter types.
** 004 SBI 20180528 Fixed embedded optional parameter to be true by default.
** 005 SBI 20181207 Added openMimeResource(String filePath, boolean embedded).
** 006 SBI 20191104 Added deleteContent parameter for openMimeResource.
** 007 SBI 20210314 Fixed javadoc to express the following changes that url string path is generalized by uri string path,
** where it is applicable.
*/
/*
** This program is free software: you can redistribute it and/or modify
** it under the terms of the GNU Affero General Public License as
** published by the Free Software Foundation, either version 3 of the
** License, or (at your option) any later version.
**
** This program 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 Affero General Public License for more details.
**
** You may find a copy of the GNU Affero GPL version 3 at the following
** location: https://www.gnu.org/licenses/agpl-3.0.en.html
**
** Additional terms under GNU Affero GPL version 3 section 7:
**
** Under Section 7 of the GNU Affero GPL version 3, the following additional
** terms apply to the works covered under the License. These additional terms
** are non-permissive additional terms allowed under Section 7 of the GNU
** Affero GPL version 3 and may not be removed by you.
**
** 0. Attribution Requirement.
**
** You must preserve all legal notices or author attributions in the covered
** work or Appropriate Legal Notices displayed by works containing the covered
** work. You may not remove from the covered work any author or developer
** credit already included within the covered work.
**
** 1. No License To Use Trademarks.
**
** This license does not grant any license or rights to use the trademarks
** Golden Code, FWD, any Golden Code or FWD logo, or any other trademarks
** of Golden Code Development Corporation. You are not authorized to use the
** name Golden Code, FWD, or the names of any author or contributor, for
** publicity purposes without written authorization.
**
** 2. No Misrepresentation of Affiliation.
**
** You may not represent yourself as Golden Code Development Corporation or FWD.
**
** You may not represent yourself for publicity purposes as associated with
** Golden Code Development Corporation, FWD, or any author or contributor to
** the covered work, without written authorization.
**
** 3. No Misrepresentation of Source or Origin.
**
** You may not represent the covered work as solely your work. All modified
** versions of the covered work must be marked in a reasonable way to make it
** clear that the modified work is not originating from Golden Code Development
** Corporation or FWD. All modified versions must contain the notices of
** attribution required in this license.
*/
package com.goldencode.p2j.util;
import java.util.List;
import com.goldencode.p2j.ui.LogicalTerminal;
/**
* Manage to open web pages in the browser's window.
*/
public class WebBrowserManager
{
/**
* Opens the specified resource in a browser's window.
*
* @param mimeType
* The resource mime type.
* @param uriPath
* The uri path to the target resource.
*/
public static void openMimeResource(String mimeType, String uriPath)
{
openMimeResource(false, mimeType, uriPath, true);
}
/**
* Opens the specified resource in a browser's window.
*
* @param deleteContent
* Indicates if the source content will be deleted after the document is loaded by
* the client.
* @param mimeType
* The resource mime type.
* @param uriPath
* The uri path to the target resource.
*/
public static void openMimeResource(boolean deleteContent, String mimeType, String uriPath)
{
openMimeResource(deleteContent, mimeType, uriPath, true);
}
/**
* Opens the specified resource in a browser's window.
*
* @param deleteContent
* Indicates if the source content will be deleted after the document is loaded by
* the client.
* @param mimeType
* The resource mime type.
* @param uriPath
* The uri path to the target resource.
* @param embedded
* The document is embedded in the template document.
*/
public static void openMimeResource(boolean deleteContent,
String mimeType,
String uriPath,
boolean embedded)
{
LogicalTerminal.getClient().openMimeResource(deleteContent, mimeType, uriPath, embedded);
}
/**
* Opens the specified resource in a browser's window.
*
* @param mimeType
* The resource mime type.
* @param uriPath
* The uri path to the target resource.
* @param embedded
* The document is embedded in the template document.
*/
public static void openMimeResource(String mimeType, String uriPath, boolean embedded)
{
openMimeResource(false, mimeType, uriPath, embedded);
}
/**
* Opens the specified file resource in a browser's window.
*
* @param deleteContent
* Indicates if the source content will be deleted after the document is loaded by
* the client.
* @param filePath
* The file path to the target resource.
* @param embedded
* The document is embedded in the template document.
* @param preferredMimeTypes
* The preferred resource mime types.
*/
public static void openMimeResource(boolean deleteContent,
String filePath,
boolean embedded,
List<String> preferredMimeTypes)
{
LogicalTerminal.getClient().openMimeResource(deleteContent,
filePath,
embedded,
preferredMimeTypes);
}
/**
* Opens the specified file resource in a browser's window.
*
* @param filePath
* The file path to the target resource.
* @param embedded
* The document is embedded in the template document.
* @param preferredMimeTypes
* The preferred resource mime types.
*/
public static void openMimeResource(String filePath,
boolean embedded,
List<String> preferredMimeTypes)
{
openMimeResource(false, filePath, embedded, preferredMimeTypes);
}
/**
* Opens the specified resource in a browser's window.
*
* @param mimeType
* The resource mime type.
* @param path
* The url path to the target resource.
* @param embedded
* The document is embedded in the template document.
*/
public static void openMimeResource(character mimeType, character path, logical embedded)
{
openMimeResource(mimeType, path, embedded.booleanValue());
}
/**
* Opens the specified resource in a browser's window.
*
* @param mimeType
* The resource mime type.
* @param path
* The url path to the target resource.
* @param embedded
* The document is embedded in the template document.
*/
public static void openMimeResource(character mimeType, character path, boolean embedded)
{
openMimeResource(mimeType.toJavaType(), path.toJavaType(), embedded);
}
/**
* Opens the specified resource in a browser's window.
*
* @param deleteContent
* Indicates if the source content will be deleted after the document is loaded by
* the client.
* @param mimeType
* The resource mime type.
* @param uriPath
* The uri path to the target resource.
* @param embedded
* The document is embedded in the template document.
*/
public static void openMimeResource(boolean deleteContent,
character mimeType,
character uriPath,
boolean embedded)
{
openMimeResource(deleteContent, mimeType.toJavaType(), uriPath.toJavaType(), embedded);
}
/**
* Opens the specified resource in a browser's window.
*
* @param deleteContent
* Indicates if the source content will be deleted after the document is loaded by
* the client.
* @param mimeType
* The resource mime type.
* @param uriPath
* The uri path to the target resource.
* @param embedded
* The document is embedded in the template document.
*/
public static void openMimeResource(boolean deleteContent,
character mimeType,
String uriPath,
boolean embedded)
{
openMimeResource(deleteContent, mimeType.toJavaType(), uriPath, embedded);
}
/**
* Opens the specified resource in a browser's window.
*
* @param deleteContent
* Indicates if the source content will be deleted after the document is loaded by
* the client.
* @param mimeType
* The resource mime type.
* @param uriPath
* The uri path to the target resource.
* @param embedded
* The document is embedded in the template document.
*/
public static void openMimeResource(boolean deleteContent,
String mimeType,
character uriPath,
boolean embedded)
{
openMimeResource(deleteContent, mimeType, uriPath.toJavaType(), embedded);
}
/**
* Opens the specified resource in a browser's window.
*
* @param deleteContent
* Indicates if the source content will be deleted after the document is loaded by
* the client.
* @param mimeType
* The resource mime type.
* @param uriPath
* The uri path to the target resource.
*/
public static void openMimeResource(boolean deleteContent, character mimeType, character uriPath)
{
openMimeResource(deleteContent, mimeType.toJavaType(), uriPath.toJavaType(), true);
}
/**
* Opens the specified resource in a browser's window.
*
* @param mimeType
* The resource mime type.
* @param path
* The url path to the target resource.
*/
public static void openMimeResource(character mimeType, character path)
{
openMimeResource(mimeType.toJavaType(), path.toJavaType(), true);
}
/**
* Opens the specified resource in a browser's window.
*
* @param mimeType
* The resource mime type.
* @param path
* The url path to the target resource.
*/
public static void openMimeResource(String mimeType, character path)
{
openMimeResource(mimeType, path.toJavaType(), true);
}
/**
* Opens the specified resource in a browser's window.
*
* @param deleteContent
* Indicates if the source content will be deleted after the document is loaded by
* the client.
* @param mimeType
* The resource mime type.
* @param uriPath
* The uri path to the target resource.
*/
public static void openMimeResource(boolean deleteContent, String mimeType, character uriPath)
{
openMimeResource(deleteContent, mimeType, uriPath.toJavaType(), true);
}
/**
* Opens the specified resource in a browser's window.
*
* @param mimeType
* The resource mime type.
* @param path
* The url path to the target resource.
*/
public static void openMimeResource(character mimeType, String path)
{
openMimeResource(mimeType.toJavaType(), path, true);
}
/**
* Opens the specified resource in a browser's window.
*
* @param deleteContent
* Indicates if the source content will be deleted after the document is loaded by
* the client.
* @param mimeType
* The resource mime type.
* @param uriPath
* The uri path to the target resource.
*/
public static void openMimeResource(boolean deleteContent, character mimeType, String uriPath)
{
openMimeResource(deleteContent, mimeType.toJavaType(), uriPath, true);
}
/**
* Opens the specified resource in a browser's window.
*
* @param mimeType
* The resource mime type.
* @param path
* The url path to the target resource.
* @param embedded
* The document is embedded in the template document.
*/
public static void openMimeResource(String mimeType, character path, boolean embedded)
{
openMimeResource(mimeType, path.toJavaType(), embedded);
}
/**
* Opens the specified resource in a browser's window.
*
* @param mimeType
* The resource mime type.
* @param path
* The url path to the target resource.
* @param embedded
* The document is embedded in the template document.
*/
public static void openMimeResource(character mimeType, String path, boolean embedded)
{
openMimeResource(mimeType.toJavaType(), path, embedded);
}
/**
* Opens the specified resource in a browser's window.
*
* @param mimeType
* The resource mime type.
* @param path
* The url path to the target resource.
* @param embedded
* The document is embedded in the template document.
*/
public static void openMimeResource(String mimeType, character path, logical embedded)
{
openMimeResource(mimeType, path.toJavaType(), embedded.booleanValue());
}
/**
* Opens the specified resource in a browser's window.
*
* @param mimeType
* The resource mime type.
* @param path
* The url path to the target resource.
* @param embedded
* The document is embedded in the template document.
*/
public static void openMimeResource(character mimeType, String path, logical embedded)
{
openMimeResource(mimeType.toJavaType(), path, embedded.booleanValue());
}
/**
* Opens the target page in a browser's window.
*
* @param path
* The url path to the target resource.
*/
public static void openURL(String path)
{
LogicalTerminal.getClient().openMimeResource(false, "application/octet-stream", path, false);
}
/**
* Opens the target page or resource in a browser's window.
*
* @param path
* The url path to the target resource.
*/
public static void openURL(character path)
{
openURL(path.toJavaType());
}
}