org.apache.myfaces.custom.roundeddiv
Class AbstractHtmlRoundedDiv

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          javax.faces.component.UIOutput
              org.apache.myfaces.custom.htmlTag.AbstractHtmlTag
                  org.apache.myfaces.custom.htmlTag.HtmlTag
                      org.apache.myfaces.custom.div.AbstractDiv
                          org.apache.myfaces.custom.div.Div
                              org.apache.myfaces.custom.roundeddiv.AbstractHtmlRoundedDiv

All Implemented Interfaces:

javax.faces.component.StateHolder, javax.faces.component.ValueHolder, org.apache.myfaces.component.EventAware, org.apache.myfaces.component.ForceIdAware, org.apache.myfaces.component.StyleAware, org.apache.myfaces.component.UniversalProperties, org.apache.myfaces.component.UserRoleAware

Direct Known Subclasses:

HtmlRoundedDiv

public abstract class AbstractHtmlRoundedDiv
extends org.apache.myfaces.custom.div.Div

Component that allows for a rounded border effect on DIV tags that is supported in CSS2 compatible browsers and IE6.

Component that generates a DIV tag with rounded corners that may be either 3D or 2D in appearence.

The "roundedDiv" component creates a DIV tag that contains images to produce rounded corners. The rounded effect can be either 3D with lighting effects or 2D with a solid color border.

Version:

$Revision: 676950 $ $Date: 2008-07-15 11:09:46 -0500 (Tue, 15 Jul 2008) $

Author:

Andrew Robinson (latest modification by $Author: skitching $)

Field Summary

static java.lang.String

COMPONENT_TYPE

Fields inherited from class org.apache.myfaces.custom.div.Div

COMPONENT_FAMILY

Fields inherited from interface org.apache.myfaces.component.UserRoleAware

ENABLED_ON_USER_ROLE_ATTR, VISIBLE_ON_USER_ROLE_ATTR

Constructor Summary

AbstractHtmlRoundedDiv()
Default constructor

Method Summary

abstract java.lang.String	getBackgroundColor() Background color to give the corners.
abstract java.lang.String	getBorderColor() The color of the border.
abstract java.lang.Integer	getBorderWidth() The width of the border in pixels.
abstract java.lang.String	getColor() The foreground color of the DIV
abstract java.lang.String	getContentStyle() The CSS style to give to the content DIV or TD (based on layout)
abstract java.lang.String	getContentStyleClass() The CSS style class to give to the content DIV or TD (based on layout)
abstract java.lang.String	getCorners() This allows you to specify a comma-separated list of corners to include.
abstract java.lang.Boolean	getInverse() Flips the lightening/darkening effect for 3D borders.
abstract java.lang.String	getLayout() Either "table" or "div".
abstract java.lang.Integer	getRadius() The radius of the corners in pixels.
abstract java.lang.String	getSize() If given, a static size image will be produced.
java.lang.String	getStyle()
java.lang.Object	getValue()

Methods inherited from class org.apache.myfaces.custom.div.Div

getDir, getFamily, getLang, getOnclick, getOndblclick, getOnkeydown, getOnkeypress, getOnkeyup, getOnmousedown, getOnmousemove, getOnmouseout, getOnmouseover, getOnmouseup, getTitle, restoreState, saveState, setDir, setLang, setOnclick, setOndblclick, setOnkeydown, setOnkeypress, setOnkeyup, setOnmousedown, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setTitle

Methods inherited from class org.apache.myfaces.custom.htmlTag.HtmlTag

getEnabledOnUserRole, getStyleClass, getVisibleOnUserRole, isForceId, isForceIdIndex, setEnabledOnUserRole, setForceId, setForceIdIndex, setStyle, setStyleClass, setVisibleOnUserRole

Methods inherited from class org.apache.myfaces.custom.htmlTag.AbstractHtmlTag

getClientId, getConverter, isRendered, setConverter

Methods inherited from class javax.faces.component.UIOutput

getLocalValue, setValue

Methods inherited from class javax.faces.component.UIComponentBase

addFacesListener, broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getFacesContext, getFacesListeners, getFacet, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding

Methods inherited from class java.lang.Object

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

Field Detail

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

See Also:

Constant Field Values

Constructor Detail

AbstractHtmlRoundedDiv

public AbstractHtmlRoundedDiv()

Default constructor

Method Detail

getContentStyle

public abstract java.lang.String getContentStyle()

The CSS style to give to the content DIV or TD (based on layout)

Returns:

the contentStyle

getContentStyleClass

public abstract java.lang.String getContentStyleClass()

The CSS style class to give to the content DIV or TD (based on layout)

Returns:

the contentStyleClass

getLayout

public abstract java.lang.String getLayout()

Either "table" or "div". Specifies how the output should be rendered. Size must be null if using "table" (if it is not, a div will be rendered). (Default: div)

Returns:

getBackgroundColor

public abstract java.lang.String getBackgroundColor()

Background color to give the corners. Leave blank (null) to have a transparent background. If the user is using IE6, this has to be set, or the corners will not look good due to IE6's lack of PNG support.

Returns:

the backgroundColor

getBorderColor

public abstract java.lang.String getBorderColor()

The color of the border. If specified, this will cause the DIV to be 2D, if it isn't the border with have a 3D effect with lighting effects to produce the border color.

Returns:

the borderColor

getInverse

public abstract java.lang.Boolean getInverse()

Flips the lightening/darkening effect for 3D borders. (Default: false)

Returns:

the inverse

getBorderWidth

public abstract java.lang.Integer getBorderWidth()

The width of the border in pixels. (Default: 8)

Returns:

the borderWidth

getCorners

public abstract java.lang.String getCorners()

This allows you to specify a comma-separated list of corners to include. If not given, all four corners will be rendered. The corners include the sides they touch. So for example, if used as a tab for a tabbed pane, you could specify "topleft,topright" to have everything but the bottom corners and side have the border. Valid values are: topleft, topright, bottomright, bottomleft

Returns:

the corners

getColor

public abstract java.lang.String getColor()

The foreground color of the DIV

Returns:

the color

getRadius

public abstract java.lang.Integer getRadius()

The radius of the corners in pixels. (Default: 8)

Returns:

the radius

getSize

public abstract java.lang.String getSize()

If given, a static size image will be produced. This could be useful for older browsers. If not given, the DIV that will be created will stretch to its contents using CSS2 (and CSS expressions in IE6). Value must contain two numbers, with width first. Example: 640x480

Returns:

the size

getStyle

public java.lang.String getStyle()

Specified by:

getStyle in interface org.apache.myfaces.component.StyleAware

Overrides:

getStyle in class org.apache.myfaces.custom.htmlTag.HtmlTag

See Also:

HtmlTag.getStyle()

getValue

public java.lang.Object getValue()

Specified by:

getValue in interface javax.faces.component.ValueHolder

Overrides:

getValue in class org.apache.myfaces.custom.div.AbstractDiv

See Also:

AbstractDiv.getValue()