org.wings.SBorderFactory Maven / Gradle / Ivy
/*
* @(#)SBorderFactory.java 1.0 01/01/02
*
* Factory inspired by javax.swing.BorderFactory
*/
package org.wings;
import java.awt.Color;
import org.wings.border.*;
/**
* Factory class for standard SBorder elements.
*/
public class SBorderFactory
{
/** We are static */
private SBorderFactory() {
}
//// LineBorder ///////////////////////////////////////////////////////////////
/**
* Creates a line SBorder withe the specified color.
*
* @param color a Color to use for the line
* @return the SBorder object
*/
public static SBorder createSLineBorder(Color color) {
return new SLineBorder(color, 1);
}
/**
* Creates a line SBorder with the specified color
* and width. The width applies to all four sides of the
* SBorder. To specify widths individually for the top,
* bottom, left, and right, use
* {@link #createSEmptyBorder(int, int, int, int)}.
*
* @param color a Color to use for the line
* @param thickness an integer specifying the width in pixels
* @return the SBorder object
*/
public static SBorder createSLineBorder(Color color, int thickness) {
return new SLineBorder(color, thickness);
}
//// BevelBorder /////////////////////////////////////////////////////////////
/**
* Creates a SBorder with a raised beveled edge, using
* brighter shades of the component's current background color
* for highlighting, and darker shading for shadows.
* (In a raised SBorder, highlights are on top and shadows
* are underneath.)
*
* @return the SBorder object
*/
public static SBorder createRaisedSBevelBorder() {
return new SBevelBorder(SBevelBorder.RAISED);
}
/**
* Creates a SBorder with a lowered beveled edge, using
* brighter shades of the component's current background color
* for highlighting, and darker shading for shadows.
* (In a lowered SBorder, shadows are on top and highlights
* are underneath.)
*
* @return the SBorder object
*/
public static SBorder createLoweredSBevelBorder() {
return new SBevelBorder(SBevelBorder.LOWERED);
}
/**
* Creates a beveled SBorder of the specified type, using
* brighter shades of the component's current background color
* for highlighting, and darker shading for shadows.
* (In a lowered SBorder, shadows are on top and highlights
* are underneath.)
*
* @param type an integer specifying either
* BevelBorder.LOWERED or
* BevelBorder.RAISED
* @return the SBorder object
*/
public static SBorder createSBevelBorder(int type) {
return new SBevelBorder(type);
}
/**
* Creates a beveled SBorder of the specified type, using
* the specified highlighting and shadowing. The outer
* edge of the highlighted area uses a brighter shade of
* the highlight color. The inner edge of the shadow area
* uses a brighter shade of the shadow color.
*
* @param type an integer specifying either
* BevelBorder.LOWERED or
* BevelBorder.RAISED
* @param highlight a Color object for highlights
* @param shadow a Color object for shadows
* @return the SBorder object
*/
/* public static SBorder createSBevelBorder(int type, Color highlight, Color shadow) {
return new SBevelBorder(type, highlight, shadow);
} */
/**
* Creates a beveled SBorder of the specified type, using
* the specified colors for the inner and outer highlight
* and shadow areas.
*
* Note: The shadow inner and outer colors are
* switched for a lowered bevel SBorder.
*
* @param type an integer specifying either
* BevelBorder.LOWERED or
* BevelBorder.RAISED
* @param highlightOuter a Color object for the
* outer edge of the highlight area
* @param highlightInner a Color object for the
* inner edge of the highlight area
* @param shadowOuter a Color object for the
* outer edge of the shadow area
* @param shadowInner a Color object for the
* inner edge of the shadow area
* @return the SBorder object
*/
/* public static SBorder createSBevelBorder(int type,
Color highlightOuter, Color highlightInner,
Color shadowOuter, Color shadowInner) {
return new SBevelBorder(type, highlightOuter, highlightInner,
shadowOuter, shadowInner);
}
*/
//// EtchedBorder ///////////////////////////////////////////////////////////
/**
* Creates a SBorder with an "etched" look using
* the component's current background color for
* highlighting and shading.
*
* @return the SBorder object
*/
public static SBorder createSEtchedBorder() {
return new SEtchedBorder();
}
/**
* Creates a SBorder with an "etched" look using
* the specified highlighting and shading colors.
*
* @param etchedType Raised or Lowered
* @return the SBorder object
*/
public static SBorder createSEtchedBorder(int etchedType) {
return new SEtchedBorder(etchedType);
}
/**
* Creates a SBorder with an "etched" look using
* the specified highlighting and shading colors.
*
* @param type one of EtchedBorder.RAISED, or
* EtchedBorder.LOWERED
* @param highlight a Color object for the SBorder highlights
* @param shadow a Color object for the SBorder shadows
* @return the SBorder object
* @since 1.3
*/
/* public static SBorder createSEtchedBorder(int type, Color highlight,
Color shadow) {
return new SEtchedBorder(type, highlight, shadow);
}
*/
//// EmptyBorder ///////////////////////////////////////////////////////////
/**
* Creates an empty SBorder that takes up no space. (The width
* of the top, bottom, left, and right sides are all zero.)
*
* @return the SBorder object
*/
public static SBorder createSEmptyBorder() {
return new SEmptyBorder(0, 0, 0, 0);
}
/**
* Creates an empty SBorder that takes up space but which does
* no drawing, specifying the width of the top, left, bottom, and
* right sides.
*
* @param top an integer specifying the width of the top,
* in pixels
* @param left an integer specifying the width of the left side,
* in pixels
* @param bottom an integer specifying the width of the bottom,
* in pixels
* @param right an integer specifying the width of the right side,
* in pixels
* @return the SBorder object
*/
public static SBorder createSEmptyBorder(int top, int left,
int bottom, int right) {
return new SEmptyBorder(top, left, bottom, right);
}
}