org.apache.myfaces.custom.roundeddiv
Class HtmlRoundedDiv

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by javax.faces.component.UIOutput
              extended by org.apache.myfaces.custom.htmlTag.AbstractHtmlTag
                  extended by org.apache.myfaces.custom.htmlTag.HtmlTag
                      extended by org.apache.myfaces.custom.div.AbstractDiv
                          extended by org.apache.myfaces.custom.div.Div
                              extended by org.apache.myfaces.custom.roundeddiv.AbstractHtmlRoundedDiv
                                  extended by org.apache.myfaces.custom.roundeddiv.HtmlRoundedDiv
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

public class HtmlRoundedDiv
extends AbstractHtmlRoundedDiv


Field Summary
static java.lang.String COMPONENT_FAMILY
           
static java.lang.String COMPONENT_TYPE
           
static java.lang.String DEFAULT_RENDERER_TYPE
           
 
Fields inherited from interface org.apache.myfaces.component.UserRoleAware
ENABLED_ON_USER_ROLE_ATTR, VISIBLE_ON_USER_ROLE_ATTR
 
Constructor Summary
HtmlRoundedDiv()
           
 
Method Summary
 java.lang.String getBackgroundColor()
          Background color to give the corners.
 java.lang.String getBorderColor()
          The color of the border.
 java.lang.Integer getBorderWidth()
          The width of the border in pixels.
 java.lang.String getColor()
          The foreground color of the DIV
 java.lang.String getContentStyle()
          The CSS style to give to the content DIV or TD (based on layout)
 java.lang.String getContentStyleClass()
          The CSS style class to give to the content DIV or TD (based on layout)
 java.lang.String getCorners()
          This allows you to specify a comma-separated list of corners to include.
 java.lang.String getFamily()
           
 java.lang.Boolean getInverse()
          Flips the lightening/darkening effect for 3D borders.
 java.lang.String getLayout()
          Either "table" or "div".
 java.lang.Integer getRadius()
          The radius of the corners in pixels.
 java.lang.String getSize()
          If given, a static size image will be produced.
 void restoreState(javax.faces.context.FacesContext facesContext, java.lang.Object state)
           
 java.lang.Object saveState(javax.faces.context.FacesContext facesContext)
           
 void setBackgroundColor(java.lang.String backgroundColor)
           
 void setBorderColor(java.lang.String borderColor)
           
 void setBorderWidth(java.lang.Integer borderWidth)
           
 void setColor(java.lang.String color)
           
 void setContentStyle(java.lang.String contentStyle)
           
 void setContentStyleClass(java.lang.String contentStyleClass)
           
 void setCorners(java.lang.String corners)
           
 void setInverse(java.lang.Boolean inverse)
           
 void setLayout(java.lang.String layout)
           
 void setRadius(java.lang.Integer radius)
           
 void setSize(java.lang.String size)
           
 
Methods inherited from class org.apache.myfaces.custom.roundeddiv.AbstractHtmlRoundedDiv
getStyle, getValue
 
Methods inherited from class org.apache.myfaces.custom.div.Div
getDir, getLang, getOnclick, getOndblclick, getOnkeydown, getOnkeypress, getOnkeyup, getOnmousedown, getOnmousemove, getOnmouseout, getOnmouseover, getOnmouseup, getTitle, 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_FAMILY

public static final java.lang.String COMPONENT_FAMILY
See Also:
Constant Field Values

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE
See Also:
Constant Field Values

DEFAULT_RENDERER_TYPE

public static final java.lang.String DEFAULT_RENDERER_TYPE
See Also:
Constant Field Values
Constructor Detail

HtmlRoundedDiv

public HtmlRoundedDiv()
Method Detail

getFamily

public java.lang.String getFamily()
Overrides:
getFamily in class org.apache.myfaces.custom.div.Div

getContentStyle

public java.lang.String getContentStyle()
Description copied from class: AbstractHtmlRoundedDiv
The CSS style to give to the content DIV or TD (based on layout)

Specified by:
getContentStyle in class AbstractHtmlRoundedDiv
Returns:
the contentStyle

setContentStyle

public void setContentStyle(java.lang.String contentStyle)

getContentStyleClass

public java.lang.String getContentStyleClass()
Description copied from class: AbstractHtmlRoundedDiv
The CSS style class to give to the content DIV or TD (based on layout)

Specified by:
getContentStyleClass in class AbstractHtmlRoundedDiv
Returns:
the contentStyleClass

setContentStyleClass

public void setContentStyleClass(java.lang.String contentStyleClass)

getLayout

public java.lang.String getLayout()
Description copied from class: AbstractHtmlRoundedDiv
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)

Specified by:
getLayout in class AbstractHtmlRoundedDiv
Returns:

setLayout

public void setLayout(java.lang.String layout)

getBackgroundColor

public java.lang.String getBackgroundColor()
Description copied from class: AbstractHtmlRoundedDiv
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.

Specified by:
getBackgroundColor in class AbstractHtmlRoundedDiv
Returns:
the backgroundColor

setBackgroundColor

public void setBackgroundColor(java.lang.String backgroundColor)

getBorderColor

public java.lang.String getBorderColor()
Description copied from class: AbstractHtmlRoundedDiv
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.

Specified by:
getBorderColor in class AbstractHtmlRoundedDiv
Returns:
the borderColor

setBorderColor

public void setBorderColor(java.lang.String borderColor)

getInverse

public java.lang.Boolean getInverse()
Description copied from class: AbstractHtmlRoundedDiv
Flips the lightening/darkening effect for 3D borders. (Default: false)

Specified by:
getInverse in class AbstractHtmlRoundedDiv
Returns:
the inverse

setInverse

public void setInverse(java.lang.Boolean inverse)

getBorderWidth

public java.lang.Integer getBorderWidth()
Description copied from class: AbstractHtmlRoundedDiv
The width of the border in pixels. (Default: 8)

Specified by:
getBorderWidth in class AbstractHtmlRoundedDiv
Returns:
the borderWidth

setBorderWidth

public void setBorderWidth(java.lang.Integer borderWidth)

getCorners

public java.lang.String getCorners()
Description copied from class: AbstractHtmlRoundedDiv
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

Specified by:
getCorners in class AbstractHtmlRoundedDiv
Returns:
the corners

setCorners

public void setCorners(java.lang.String corners)

getColor

public java.lang.String getColor()
Description copied from class: AbstractHtmlRoundedDiv
The foreground color of the DIV

Specified by:
getColor in class AbstractHtmlRoundedDiv
Returns:
the color

setColor

public void setColor(java.lang.String color)

getRadius

public java.lang.Integer getRadius()
Description copied from class: AbstractHtmlRoundedDiv
The radius of the corners in pixels. (Default: 8)

Specified by:
getRadius in class AbstractHtmlRoundedDiv
Returns:
the radius

setRadius

public void setRadius(java.lang.Integer radius)

getSize

public java.lang.String getSize()
Description copied from class: AbstractHtmlRoundedDiv
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

Specified by:
getSize in class AbstractHtmlRoundedDiv
Returns:
the size

setSize

public void setSize(java.lang.String size)

saveState

public java.lang.Object saveState(javax.faces.context.FacesContext facesContext)
Specified by:
saveState in interface javax.faces.component.StateHolder
Overrides:
saveState in class org.apache.myfaces.custom.div.Div

restoreState

public void restoreState(javax.faces.context.FacesContext facesContext,
                         java.lang.Object state)
Specified by:
restoreState in interface javax.faces.component.StateHolder
Overrides:
restoreState in class org.apache.myfaces.custom.div.Div


Copyright © 2011 The Apache Software Foundation. All Rights Reserved.