| /** |
| * Copyright (c) 2011, 2015 - Lunifera GmbH (Gross Enzersdorf, Austria), Loetz GmbH&Co.KG (69115 Heidelberg, Germany) |
| * All rights reserved. This program and the accompanying materials |
| * are made available under the terms of the Eclipse Public License 2.0 |
| * which accompanies this distribution, and is available at |
| * https://www.eclipse.org/legal/epl-2.0/ |
| * |
| * SPDX-License-Identifier: EPL-2.0 |
| * |
| * Contributors: |
| * Florian Pirchner - Initial implementation |
| */ |
| package org.eclipse.osbp.ecview.core.common.visibility; |
| |
| import org.eclipse.osbp.ecview.core.common.editpart.visibility.IUiElementAccess; |
| |
| // TODO: Auto-generated Javadoc |
| /** |
| * VisibilityHandlers are used to apply visibility options to the underlying UI |
| * element. Getters do not return the values contained in the UI element, but |
| * instead return the values set in this instance of handler. |
| * <p> |
| * To access information about the underlying UI element, use |
| * {@link #getUiAccess()}. |
| */ |
| public interface IVisibilityHandler { |
| |
| /** |
| * Returns an instance to access information about the underlying UI |
| * element. |
| * |
| * @return the ui access |
| */ |
| IUiElementAccess getUiAccess(); |
| |
| /** |
| * Resets the options to their default values. |
| */ |
| void reset(); |
| |
| /** |
| * Returns the foregroundColor property or <code>null</code> if not present. |
| * |
| * @return the foreground color |
| */ |
| Color getForegroundColor(); |
| |
| /** |
| * Sets the <code>foregroundColor</code> property to this instance. |
| * |
| * @param foregroundColor |
| * - the property |
| * |
| */ |
| void setForegroundColor(final Color foregroundColor); |
| |
| /** |
| * Returns the backgroundColor property or <code>null</code> if not present. |
| * |
| * @return the background color |
| */ |
| Color getBackgroundColor(); |
| |
| /** |
| * Sets the <code>backgroundColor</code> property to this instance. |
| * |
| * @param backgroundColor |
| * - the property |
| */ |
| void setBackgroundColor(final Color backgroundColor); |
| |
| /** |
| * Returns the foregroundColorCode property or <code>null</code> if not |
| * present. |
| * |
| * @return the foreground color code |
| */ |
| String getForegroundColorCode(); |
| |
| /** |
| * Sets the <code>foregroundColorCode</code> property to this instance. |
| * |
| * @param foregroundColorCode |
| * - the property |
| * |
| */ |
| void setForegroundColorCode(String foregroundColorCode); |
| |
| /** |
| * Returns the backgroundColorCode property or <code>null</code> if not |
| * present. |
| * |
| * @return the background color code |
| */ |
| String getBackgroundColorCode(); |
| |
| /** |
| * Sets the <code>backgroundColorCode</code> property to this instance. |
| * |
| * @param backgroundColor |
| * the new background color code |
| */ |
| void setBackgroundColorCode(final String backgroundColor); |
| |
| /** |
| * Returns the editable property or <code>null</code> if not present. |
| * |
| * @return true, if is editable |
| */ |
| boolean isEditable(); |
| |
| /** |
| * Sets the <code>editable</code> property to this instance. |
| * |
| * @param editable |
| * - the property |
| */ |
| void setEditable(final boolean editable); |
| |
| /** |
| * Returns the enabled property or <code>null</code> if not present. |
| * |
| * @return true, if is enabled |
| */ |
| boolean isEnabled(); |
| |
| /** |
| * Sets the <code>enabled</code> property to this instance. |
| * |
| * @param enabled |
| * - the property |
| */ |
| void setEnabled(final boolean enabled); |
| |
| /** |
| * Returns the visible property or <code>null</code> if not present. |
| * |
| * @return true, if is visible |
| */ |
| boolean isVisible(); |
| |
| /** |
| * Sets the <code>visible</code> property to this instance. |
| * |
| * @param visible |
| * - the property |
| */ |
| void setVisible(final boolean visible); |
| |
| /** |
| * Returns the bold property or <code>null</code> if not present. |
| * |
| * @return true, if is bold |
| */ |
| boolean isBold(); |
| |
| /** |
| * Sets the <code>bold</code> property to this instance. |
| * |
| * @param bold |
| * - the property |
| */ |
| void setBold(final boolean bold); |
| |
| /** |
| * Returns the border property or <code>null</code> if not present. |
| * |
| * @return true, if is border |
| */ |
| boolean isBorder(); |
| |
| /** |
| * Sets the <code>border</code> property to this instance. |
| * |
| * @param border |
| * - the property |
| */ |
| void setBorder(final boolean border); |
| |
| /** |
| * Returns the italic property or <code>null</code> if not present. |
| * |
| * @return true, if is italic |
| */ |
| boolean isItalic(); |
| |
| /** |
| * Sets the <code>italic</code> property to this instance. |
| * |
| * @param italic |
| * - the property |
| */ |
| void setItalic(final boolean italic); |
| |
| /** |
| * Returns the strikethrough property or <code>null</code> if not present. |
| * |
| * @return true, if is strikethrough |
| */ |
| boolean isStrikethrough(); |
| |
| /** |
| * Sets the <code>strikethrough</code> property to this instance. |
| * |
| * @param strikethrough |
| * - the property |
| */ |
| void setStrikethrough(final boolean strikethrough); |
| |
| /** |
| * Returns the underline property or <code>null</code> if not present. |
| * |
| * @return true, if is underline |
| */ |
| boolean isUnderline(); |
| |
| /** |
| * Sets the <code>underline</code> property to this instance. |
| * |
| * @param underline |
| * - the property |
| */ |
| void setUnderline(final boolean underline); |
| |
| /** |
| * Returns the css value or <code>null</code> if not present. |
| * |
| * @return the css class |
| */ |
| String getCssClass(); |
| |
| /** |
| * Sets the <code>cssClass</code> property to this instance. |
| * |
| * @param cssClass |
| * - the property |
| * |
| */ |
| void setCssClass(String cssClass); |
| |
| /** |
| * Returns the css ID or <code>null</code> if not present. |
| * |
| * @return the css id |
| */ |
| String getCssId(); |
| |
| /** |
| * Sets the <code>cssId</code> property to this instance. |
| * |
| * @param cssId |
| * - the property |
| * |
| */ |
| void setCssId(String cssId); |
| |
| /** |
| * Applies the options to the assigned UI element. |
| */ |
| void apply(); |
| |
| /** |
| * To string. |
| * |
| * @return the string |
| */ |
| String toString(); |
| |
| /** |
| * The Class NotValidProcessableException. |
| */ |
| public class NotValidProcessableException extends Exception { |
| |
| /** |
| * Instantiates a new not valid processable exception. |
| * |
| * @param message |
| * the message |
| */ |
| public NotValidProcessableException(String message) { |
| super(message); |
| } |
| } |
| |
| } |