org.netbeans.api.io

Class OutputColor

java.lang.Object

org.netbeans.api.io.OutputColor

public abstract class OutputColor
extends Object

A color specified for part of text in output pane. It can be a predefined color for some type of text (success, debug, warning, failure), or arbitrary RGB color.

Although using wide range of custom RGB colors may be tempting, predefined colors are recommended, as they can be configured to respect GUI theme in use.

Method Summary

Modifier and Type	Method and Description
static OutputColor	debug() Debug text color.
static OutputColor	failure() Failure text color.
static OutputColor	rgb(int rgbValue) Arbitrary constant RGB color.
static OutputColor	rgb(int r, int g, int b) Arbitrary constant RGB color.
static OutputColor	success() Success text color.
static OutputColor	warning() Warning text color.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

warning

@NonNull
public static OutputColor warning()

Warning text color.

Returns:

Predefined color for text of type "warning".

failure

@NonNull
public static OutputColor failure()

Failure text color.

Returns:

Predefined color for text of type "failure".

debug

@NonNull
public static OutputColor debug()

Debug text color.

Returns:

Predefined color for text of type "debug".

success

@NonNull
public static OutputColor success()

Success text color.

Returns:

Predefined color for text of type "success".

rgb

@NonNull
public static OutputColor rgb(int r,
                                       int g,
                                       int b)

Arbitrary constant RGB color.

Please note that it is recommended to use colors for predefined text types, which can respect color theme used by the GUI.

Parameters:

r - The red component, in the range (0 - 255).

g - The green component, in the range (0 - 255).

b - The blue component, in the range (0 - 255).

Returns:

Color specified for a constant RGB value.

Throws:

IllegalArgumentException - If some of color components is out of range.

rgb

@NonNull
public static OutputColor rgb(int rgbValue)

Arbitrary constant RGB color. Creates an opaque sRGB color with the specified combined RGB value consisting of the red component in bits 16-23, the green component in bits 8-15, and the blue component in bits 0-7.

Please note that it is recommended to use colors for predefined text types, which can respect color theme used by the GUI.

Parameters:

rgbValue - The combined RGB components.

Returns:

Color specified for a constant RGB value.