|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.faces.component.UIComponent
org.apache.myfaces.trinidad.component.UIXComponent
org.apache.myfaces.trinidad.component.UIXComponentBase
org.apache.myfaces.trinidad.component.html.HtmlFrame
public class HtmlFrame
The frame is used to specify attributes needed by an
HTML frame. It does not render any child nodes, and should only be used as
a facet on a frameBorderLayout component. The contents of a frame is selected
by using the source attribute.
Type | Phases | Description |
---|---|---|
org.apache.myfaces.trinidad.event.AttributeChangeEvent |
Apply Request Values | Event delivered to describe an attribute change. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing. |
Field Summary | |
---|---|
static java.lang.String |
COMPONENT_FAMILY
|
static java.lang.String |
COMPONENT_TYPE
|
static PropertyKey |
HEIGHT_KEY
|
static PropertyKey |
INLINE_STYLE_KEY
|
static PropertyKey |
LONG_DESC_URL_KEY
|
static PropertyKey |
MARGIN_HEIGHT_KEY
|
static PropertyKey |
MARGIN_WIDTH_KEY
|
static PropertyKey |
NAME_KEY
|
static PropertyKey |
PARTIAL_TRIGGERS_KEY
|
static PropertyKey |
SCROLLING_KEY
|
static PropertyKey |
SHORT_DESC_KEY
|
static PropertyKey |
SOURCE_KEY
|
static PropertyKey |
STYLE_CLASS_KEY
|
static FacesBean.Type |
TYPE
|
static PropertyKey |
WIDTH_KEY
|
Fields inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase |
---|
BINDING_KEY, ID_KEY, RENDERED_KEY, RENDERER_TYPE_KEY, TRANSIENT_KEY |
Fields inherited from class javax.faces.component.UIComponent |
---|
bindings |
Constructor Summary | |
---|---|
|
HtmlFrame()
Construct an instance of the HtmlFrame. |
protected |
HtmlFrame(java.lang.String rendererType)
Construct an instance of the HtmlFrame. |
Method Summary | |
---|---|
protected FacesBean.Type |
getBeanType()
|
java.lang.String |
getFamily()
|
java.lang.String |
getHeight()
Gets the proposed height of this frame. |
java.lang.String |
getInlineStyle()
Gets the inline CSS style for this element |
java.lang.String |
getLongDescURL()
Gets This attribute specifies a link to a long description of the frame. |
int |
getMarginHeight()
Gets the width of the frame margin. |
int |
getMarginWidth()
Gets the width of the frame margin. |
java.lang.String |
getName()
Gets the name used to identify this frame |
java.lang.String[] |
getPartialTriggers()
Gets the IDs of the components that should trigger a partial update. |
java.lang.String |
getScrolling()
Gets whether or not scrollbars are available on this frame. |
java.lang.String |
getShortDesc()
Gets the short description of the bean. |
java.lang.String |
getSource()
Gets the URI for the source of this frame This is a required property on the component. |
java.lang.String |
getStyleClass()
Gets the CSS style class of the bean. |
java.lang.String |
getWidth()
Gets the proposed width of this frame This can be in pixels or percentage. |
void |
setHeight(java.lang.String height)
Sets the proposed height of this frame. |
void |
setInlineStyle(java.lang.String inlineStyle)
Sets the inline CSS style for this element |
void |
setLongDescURL(java.lang.String longDescURL)
Sets This attribute specifies a link to a long description of the frame. |
void |
setMarginHeight(int marginHeight)
Sets the width of the frame margin. |
void |
setMarginWidth(int marginWidth)
Sets the width of the frame margin. |
void |
setName(java.lang.String name)
Sets the name used to identify this frame |
void |
setPartialTriggers(java.lang.String[] partialTriggers)
Sets the IDs of the components that should trigger a partial update. |
void |
setScrolling(java.lang.String scrolling)
Sets whether or not scrollbars are available on this frame. |
void |
setShortDesc(java.lang.String shortDesc)
Sets the short description of the bean. |
void |
setSource(java.lang.String source)
Sets the URI for the source of this frame This is a required property on the component. |
void |
setStyleClass(java.lang.String styleClass)
Sets the CSS style class of the bean. |
void |
setWidth(java.lang.String width)
Sets the proposed width of this frame This can be in pixels or percentage. |
Methods inherited from class javax.faces.component.UIComponent |
---|
getContainerClientId, invokeOnComponent |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final FacesBean.Type TYPE
public static final PropertyKey SOURCE_KEY
public static final PropertyKey LONG_DESC_URL_KEY
public static final PropertyKey NAME_KEY
public static final PropertyKey WIDTH_KEY
public static final PropertyKey HEIGHT_KEY
public static final PropertyKey MARGIN_WIDTH_KEY
public static final PropertyKey MARGIN_HEIGHT_KEY
public static final PropertyKey SCROLLING_KEY
public static final PropertyKey SHORT_DESC_KEY
public static final PropertyKey PARTIAL_TRIGGERS_KEY
public static final PropertyKey STYLE_CLASS_KEY
public static final PropertyKey INLINE_STYLE_KEY
public static final java.lang.String COMPONENT_FAMILY
public static final java.lang.String COMPONENT_TYPE
Constructor Detail |
---|
public HtmlFrame()
protected HtmlFrame(java.lang.String rendererType)
Method Detail |
---|
public final java.lang.String getSource()
This is a required property on the component.
public final void setSource(java.lang.String source)
This is a required property on the component.
source
- the new source valuepublic final java.lang.String getLongDescURL()
shortDesc
attribute, and
may be particularly useful for non-visual user agents.
public final void setLongDescURL(java.lang.String longDescURL)
shortDesc
attribute, and
may be particularly useful for non-visual user agents.
longDescURL
- the new longDescURL valuepublic final java.lang.String getName()
public final void setName(java.lang.String name)
name
- the new name valuepublic final java.lang.String getWidth()
public final void setWidth(java.lang.String width)
width
- the new width valuepublic final java.lang.String getHeight()
public final void setHeight(java.lang.String height)
height
- the new height valuepublic final int getMarginWidth()
public final void setMarginWidth(int marginWidth)
marginWidth
- the new marginWidth valuepublic final int getMarginHeight()
public final void setMarginHeight(int marginHeight)
marginHeight
- the new marginHeight valuepublic final java.lang.String getScrolling()
public final void setScrolling(java.lang.String scrolling)
scrolling
- the new scrolling valuepublic final java.lang.String getShortDesc()
public final void setShortDesc(java.lang.String shortDesc)
shortDesc
- the new shortDesc valuepublic final java.lang.String[] getPartialTriggers()
public final void setPartialTriggers(java.lang.String[] partialTriggers)
partialTriggers
- the new partialTriggers valuepublic final java.lang.String getStyleClass()
public final void setStyleClass(java.lang.String styleClass)
styleClass
- the new styleClass valuepublic final java.lang.String getInlineStyle()
public final void setInlineStyle(java.lang.String inlineStyle)
inlineStyle
- the new inlineStyle valuepublic java.lang.String getFamily()
getFamily
in class UIXComponentBase
protected FacesBean.Type getBeanType()
getBeanType
in class UIXComponentBase
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |