|
||||||||||
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.UIXPanel
org.apache.myfaces.trinidad.component.core.layout.CorePanelLabelAndMessage
public class CorePanelLabelAndMessage
Type | Phases | Description |
---|---|---|
org.apache.myfaces.trinidad.event.AttributeChangeEvent |
Invoke Application 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 event might include the width of a column that supported client-side resizing. |
Field Summary | |
---|---|
static PropertyKey |
ACCESS_KEY_KEY
|
static String |
COMPONENT_FAMILY
|
static String |
COMPONENT_TYPE
|
static String |
END_FACET
|
static PropertyKey |
FOR_KEY
|
static String |
HELP_FACET
|
static PropertyKey |
INLINE_STYLE_KEY
|
static PropertyKey |
LABEL_KEY
|
static PropertyKey |
LABEL_STYLE_KEY
|
static PropertyKey |
ONCLICK_KEY
|
static PropertyKey |
ONDBLCLICK_KEY
|
static PropertyKey |
ONKEYDOWN_KEY
|
static PropertyKey |
ONKEYPRESS_KEY
|
static PropertyKey |
ONKEYUP_KEY
|
static PropertyKey |
ONMOUSEDOWN_KEY
|
static PropertyKey |
ONMOUSEMOVE_KEY
|
static PropertyKey |
ONMOUSEOUT_KEY
|
static PropertyKey |
ONMOUSEOVER_KEY
|
static PropertyKey |
ONMOUSEUP_KEY
|
static PropertyKey |
PARTIAL_TRIGGERS_KEY
|
static PropertyKey |
SHORT_DESC_KEY
|
static PropertyKey |
SHOW_REQUIRED_KEY
|
static PropertyKey |
STYLE_CLASS_KEY
|
static FacesBean.Type |
TYPE
|
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 |
---|
BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, VIEW_LOCATION_KEY |
Constructor Summary | |
---|---|
|
CorePanelLabelAndMessage()
Construct an instance of the CorePanelLabelAndMessage. |
protected |
CorePanelLabelAndMessage(String rendererType)
Construct an instance of the CorePanelLabelAndMessage. |
Method Summary | |
---|---|
void |
addClientBehavior(String eventName,
javax.faces.component.behavior.ClientBehavior behavior)
Utility method to assist sub-classes in the implementation of the ClientBehaviorHolder interface. |
char |
getAccessKey()
Gets Character used to gain quick access to the form element specified by the for , if set (or this component itself,
if it is a "non-simple" form element). |
protected FacesBean.Type |
getBeanType()
|
Map<String,List<javax.faces.component.behavior.ClientBehavior>> |
getClientBehaviors()
Utility method to assist sub-classes in the implementation of the ClientBehaviorHolder interface. |
String |
getDefaultEventName()
Utility method to assist sub-classes in the implementation of the ClientBehaviorHolder interface. |
javax.faces.component.UIComponent |
getEnd()
Component to render after the children. |
Collection<String> |
getEventNames()
|
String |
getFamily()
|
String |
getFor()
Gets The ID of the component that this component's label refers to. |
javax.faces.component.UIComponent |
getHelp()
This facet should contain field level help. |
String |
getInlineStyle()
Gets the CSS styles to use for this component. |
String |
getLabel()
Gets the label of the bean. |
String |
getLabelStyle()
Gets Specifies inline styles for the label portion of the component, e.g. |
String |
getOnclick()
Gets an onclick Javascript handler. |
String |
getOndblclick()
Gets an ondblclick Javascript handler. |
String |
getOnkeydown()
Gets an onkeydown Javascript handler. |
String |
getOnkeypress()
Gets an onkeypress Javascript handler. |
String |
getOnkeyup()
Gets an onkeyup Javascript handler. |
String |
getOnmousedown()
Gets an onmousedown Javascript handler. |
String |
getOnmousemove()
Gets an onmousemove Javascript handler. |
String |
getOnmouseout()
Gets an onmouseout Javascript handler. |
String |
getOnmouseover()
Gets an onmouseover Javascript handler. |
String |
getOnmouseup()
Gets an onmouseup Javascript handler. |
String[] |
getPartialTriggers()
Gets the IDs of the components that should trigger a partial update. |
String |
getShortDesc()
Gets The short description of the component. |
String |
getStyleClass()
Gets a CSS style class to use for this component. |
boolean |
isShowRequired()
Gets whether the panel should show an indicator that its contents are required. |
void |
setAccessKey(char accessKey)
Sets Character used to gain quick access to the form element specified by the for , if set (or this component itself,
if it is a "non-simple" form element). |
void |
setEnd(javax.faces.component.UIComponent endFacet)
Component to render after the children. |
void |
setFor(String forParam)
Sets The ID of the component that this component's label refers to. |
void |
setHelp(javax.faces.component.UIComponent helpFacet)
This facet should contain field level help. |
void |
setInlineStyle(String inlineStyle)
Sets the CSS styles to use for this component. |
void |
setLabel(String label)
Sets the label of the bean. |
void |
setLabelStyle(String labelStyle)
Sets Specifies inline styles for the label portion of the component, e.g. |
void |
setOnclick(String onclick)
Sets an onclick Javascript handler. |
void |
setOndblclick(String ondblclick)
Sets an ondblclick Javascript handler. |
void |
setOnkeydown(String onkeydown)
Sets an onkeydown Javascript handler. |
void |
setOnkeypress(String onkeypress)
Sets an onkeypress Javascript handler. |
void |
setOnkeyup(String onkeyup)
Sets an onkeyup Javascript handler. |
void |
setOnmousedown(String onmousedown)
Sets an onmousedown Javascript handler. |
void |
setOnmousemove(String onmousemove)
Sets an onmousemove Javascript handler. |
void |
setOnmouseout(String onmouseout)
Sets an onmouseout Javascript handler. |
void |
setOnmouseover(String onmouseover)
Sets an onmouseover Javascript handler. |
void |
setOnmouseup(String onmouseup)
Sets an onmouseup Javascript handler. |
void |
setPartialTriggers(String[] partialTriggers)
Sets the IDs of the components that should trigger a partial update. |
void |
setShortDesc(String shortDesc)
Sets The short description of the component. |
void |
setShowRequired(boolean showRequired)
Sets whether the panel should show an indicator that its contents are required. |
void |
setStyleClass(String styleClass)
Sets a CSS style class to use for this component. |
Methods inherited from class javax.faces.component.UIComponent |
---|
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getResourceBundleMap, isCompositeComponent, isInView, popComponentFromEL, processEvent, pushComponentToEL, setInView |
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 INLINE_STYLE_KEY
public static final PropertyKey STYLE_CLASS_KEY
public static final PropertyKey SHORT_DESC_KEY
public static final PropertyKey PARTIAL_TRIGGERS_KEY
public static final PropertyKey ONCLICK_KEY
public static final PropertyKey ONDBLCLICK_KEY
public static final PropertyKey ONMOUSEDOWN_KEY
public static final PropertyKey ONMOUSEUP_KEY
public static final PropertyKey ONMOUSEOVER_KEY
public static final PropertyKey ONMOUSEMOVE_KEY
public static final PropertyKey ONMOUSEOUT_KEY
public static final PropertyKey ONKEYPRESS_KEY
public static final PropertyKey ONKEYDOWN_KEY
public static final PropertyKey ONKEYUP_KEY
public static final PropertyKey SHOW_REQUIRED_KEY
public static final PropertyKey LABEL_KEY
public static final PropertyKey LABEL_STYLE_KEY
public static final PropertyKey ACCESS_KEY_KEY
public static final PropertyKey FOR_KEY
public static final String HELP_FACET
public static final String END_FACET
public static final String COMPONENT_FAMILY
public static final String COMPONENT_TYPE
Constructor Detail |
---|
public CorePanelLabelAndMessage()
protected CorePanelLabelAndMessage(String rendererType)
Method Detail |
---|
public final javax.faces.component.UIComponent getHelp()
public final void setHelp(javax.faces.component.UIComponent helpFacet)
public final javax.faces.component.UIComponent getEnd()
public final void setEnd(javax.faces.component.UIComponent endFacet)
public final String getInlineStyle()
public final void setInlineStyle(String inlineStyle)
inlineStyle
- the new inlineStyle valuepublic final String getStyleClass()
public final void setStyleClass(String styleClass)
styleClass
- the new styleClass valuepublic final String getShortDesc()
public final void setShortDesc(String shortDesc)
shortDesc
- the new shortDesc valuepublic final String[] getPartialTriggers()
This component will listen on the trigger components. If one of the trigger components receives an event that will cause it to update in some way, this component will request to be updated too.
Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2"
Identifiers must account for NamingContainers. You can use a single colon to start the search from the root, or use multiple colons to move up through the NamingContainer. For example, "::" will pop out of this component's naming container (it pops out of itself if it is a naming container), ":::" will pop out of two naming containers, etc. The search for the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the component with id = commandButton1 after popping out of two naming containers relative to this component. To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".
public final void setPartialTriggers(String[] partialTriggers)
This component will listen on the trigger components. If one of the trigger components receives an event that will cause it to update in some way, this component will request to be updated too.
Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2"
Identifiers must account for NamingContainers. You can use a single colon to start the search from the root, or use multiple colons to move up through the NamingContainer. For example, "::" will pop out of this component's naming container (it pops out of itself if it is a naming container), ":::" will pop out of two naming containers, etc. The search for the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the component with id = commandButton1 after popping out of two naming containers relative to this component. To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".
partialTriggers
- the new partialTriggers valuepublic final String getOnclick()
public final void setOnclick(String onclick)
onclick
- the new onclick valuepublic final String getOndblclick()
public final void setOndblclick(String ondblclick)
ondblclick
- the new ondblclick valuepublic final String getOnmousedown()
public final void setOnmousedown(String onmousedown)
onmousedown
- the new onmousedown valuepublic final String getOnmouseup()
public final void setOnmouseup(String onmouseup)
onmouseup
- the new onmouseup valuepublic final String getOnmouseover()
public final void setOnmouseover(String onmouseover)
onmouseover
- the new onmouseover valuepublic final String getOnmousemove()
public final void setOnmousemove(String onmousemove)
onmousemove
- the new onmousemove valuepublic final String getOnmouseout()
public final void setOnmouseout(String onmouseout)
onmouseout
- the new onmouseout valuepublic final String getOnkeypress()
public final void setOnkeypress(String onkeypress)
onkeypress
- the new onkeypress valuepublic final String getOnkeydown()
public final void setOnkeydown(String onkeydown)
onkeydown
- the new onkeydown valuepublic final String getOnkeyup()
public final void setOnkeyup(String onkeyup)
onkeyup
- the new onkeyup valuepublic final boolean isShowRequired()
public final void setShowRequired(boolean showRequired)
showRequired
- the new showRequired valuepublic final String getLabel()
public final void setLabel(String label)
label
- the new label valuepublic final String getLabelStyle()
public final void setLabelStyle(String labelStyle)
labelStyle
- the new labelStyle valuepublic final char getAccessKey()
for
, if set (or this component itself,
if it is a "non-simple" form element).
For accessibility reasons, this functionality is not supported
in screen reader mode.
If the same access key appears in multiple locations in the
same page of output, the rendering user agent will cycle
among the elements accessed by the similar keys.
This attribute is sometimes referred to as the "mnemonic".
public final void setAccessKey(char accessKey)
for
, if set (or this component itself,
if it is a "non-simple" form element).
For accessibility reasons, this functionality is not supported
in screen reader mode.
If the same access key appears in multiple locations in the
same page of output, the rendering user agent will cycle
among the elements accessed by the similar keys.
This attribute is sometimes referred to as the "mnemonic".
accessKey
- the new accessKey valuepublic final String getFor()
public final void setFor(String forParam)
forParam
- the new for valuepublic String getDefaultEventName()
UIXComponentBase
ClientBehaviorHolder
interface.
This method must only be called by classes that implement the interface, doing otherwise will result in an exception.
getDefaultEventName
in interface javax.faces.component.behavior.ClientBehaviorHolder
getDefaultEventName
in class UIXComponentBase
ClientBehaviorHolder.getDefaultEventName()
public Collection<String> getEventNames()
getEventNames
in interface javax.faces.component.behavior.ClientBehaviorHolder
public Map<String,List<javax.faces.component.behavior.ClientBehavior>> getClientBehaviors()
UIXComponentBase
ClientBehaviorHolder
interface.
This method must only be called by classes that implement the interface, doing otherwise will result in an exception.
getClientBehaviors
in interface javax.faces.component.behavior.ClientBehaviorHolder
getClientBehaviors
in class UIXComponentBase
ClientBehaviorHolder.getClientBehaviors()
public void addClientBehavior(String eventName, javax.faces.component.behavior.ClientBehavior behavior)
UIXComponentBase
ClientBehaviorHolder
interface.
This method must only be called by classes that implement the interface, doing otherwise will result in an exception.
addClientBehavior
in interface javax.faces.component.behavior.ClientBehaviorHolder
addClientBehavior
in class UIXComponentBase
eventName
- The event namebehavior
- The behavior to addClientBehaviorHolder.addClientBehavior(String, ClientBehavior)
public String getFamily()
getFamily
in class UIXPanel
protected FacesBean.Type getBeanType()
getBeanType
in class UIXPanel
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |