org.apache.myfaces.trinidad.component.html.HtmlTableLayout Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of trinidad-api Show documentation
Show all versions of trinidad-api Show documentation
Public API for the Apache MyFaces Trinidad project
The newest version!
// WARNING: This file was automatically generated. Do not edit it directly,
// or you will lose your changes.
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.myfaces.trinidad.component.html;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import javax.faces.component.behavior.ClientBehavior;
import javax.faces.component.behavior.ClientBehaviorHolder;
import org.apache.myfaces.trinidad.bean.FacesBean;
import org.apache.myfaces.trinidad.bean.PropertyKey;
import org.apache.myfaces.trinidad.component.UIXComponentBase;
import org.apache.myfaces.trinidad.util.ComponentUtils;
/**
*
* A TableLayout is a thin wrapper around the HTML <table>
* element. It contains a series of row layout elements.
*
* By default, HTML tables treat cell widths more like suggestions rather than requirements;
* cell content sizes contribute more in determining the size of each column.
* If you care more for the specified cellFormat widths than content sizes (particularly if your
* cellFormat widths are percentage-based and your cells have contents that are
* programmatically-resizable based on the cell width), then you will need to use
* inlineStyle="table-layout:fixed" to declare that you want your cell widths to be explicitly honored.
* Refer to the CSS specification for further details on this style property.
*
*
* Events:
*
*
* Type
* Phases
* Description
*
*
* org.apache.myfaces.trinidad.event.AttributeChangeEventInvoke
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.
*
*
*/
public class HtmlTableLayout extends UIXComponentBase
implements ClientBehaviorHolder
{
static public final String HALIGN_RIGHT = "right";
static public final String HALIGN_START = "start";
static public final String HALIGN_LEFT = "left";
static public final String HALIGN_END = "end";
static public final String HALIGN_CENTER = "center";
static public final FacesBean.Type TYPE = new FacesBean.Type(
UIXComponentBase.TYPE);
static public final PropertyKey WIDTH_KEY =
TYPE.registerKey("width", String.class);
static public final PropertyKey HALIGN_KEY =
TYPE.registerKey("halign", String.class);
static public final PropertyKey CELL_SPACING_KEY =
TYPE.registerKey("cellSpacing", Integer.class);
static public final PropertyKey CELL_PADDING_KEY =
TYPE.registerKey("cellPadding", Integer.class);
static public final PropertyKey BORDER_WIDTH_KEY =
TYPE.registerKey("borderWidth", Integer.class);
static public final PropertyKey SUMMARY_KEY =
TYPE.registerKey("summary", String.class);
static public final PropertyKey SHORT_DESC_KEY =
TYPE.registerKey("shortDesc", String.class);
static public final PropertyKey PARTIAL_TRIGGERS_KEY =
TYPE.registerKey("partialTriggers", String[].class);
static public final PropertyKey ONCLICK_KEY =
TYPE.registerKey("onclick", String.class);
static public final PropertyKey ONDBLCLICK_KEY =
TYPE.registerKey("ondblclick", String.class);
static public final PropertyKey ONMOUSEDOWN_KEY =
TYPE.registerKey("onmousedown", String.class);
static public final PropertyKey ONMOUSEUP_KEY =
TYPE.registerKey("onmouseup", String.class);
static public final PropertyKey ONMOUSEOVER_KEY =
TYPE.registerKey("onmouseover", String.class);
static public final PropertyKey ONMOUSEMOVE_KEY =
TYPE.registerKey("onmousemove", String.class);
static public final PropertyKey ONMOUSEOUT_KEY =
TYPE.registerKey("onmouseout", String.class);
static public final PropertyKey ONKEYPRESS_KEY =
TYPE.registerKey("onkeypress", String.class);
static public final PropertyKey ONKEYDOWN_KEY =
TYPE.registerKey("onkeydown", String.class);
static public final PropertyKey ONKEYUP_KEY =
TYPE.registerKey("onkeyup", String.class);
static public final PropertyKey STYLE_CLASS_KEY =
TYPE.registerKey("styleClass", String.class);
static public final PropertyKey INLINE_STYLE_KEY =
TYPE.registerKey("inlineStyle", String.class);
static public final String COMPONENT_FAMILY =
"org.apache.myfaces.trinidad.TableLayout";
static public final String COMPONENT_TYPE =
"org.apache.myfaces.trinidad.HtmlTableLayout";
// Supported client events for client behaviors:
private final static Collection _EVENT_NAMES = Collections.unmodifiableCollection(
Arrays.asList(
"click", "dblclick", "mousedown", "mouseup", "mouseover", "mousemove",
"mouseout", "keypress", "keydown", "keyup"
));
/**
* Construct an instance of the HtmlTableLayout.
*/
public HtmlTableLayout()
{
super("org.apache.myfaces.trinidad.TableLayout");
}
/**
* Gets the preferred total width of the layout.
*
* @return the new width value
*/
final public String getWidth()
{
return ComponentUtils.resolveString(getProperty(WIDTH_KEY));
}
/**
* Sets the preferred total width of the layout.
*
* @param width the new width value
*/
final public void setWidth(String width)
{
setProperty(WIDTH_KEY, (width));
}
/**
* Sets the preferred total width of the layout.
*
* @param width the new width value
*/
final public void setWidth(int width)
{
setProperty(WIDTH_KEY, Integer.valueOf(width));
}
/**
* Gets the horizontal alignment of the table.
* The acceptable values are "center", "left", "right", "start", and "end".
*
* @return the new halign value
*/
final public String getHalign()
{
return ComponentUtils.resolveString(getProperty(HALIGN_KEY));
}
/**
* Sets the horizontal alignment of the table.
* The acceptable values are "center", "left", "right", "start", and "end".
*
* @param halign the new halign value
*/
final public void setHalign(String halign)
{
setProperty(HALIGN_KEY, (halign));
}
/**
* Gets the spacing between cells.
*
* @return the new cellSpacing value
*/
final public int getCellSpacing()
{
return ComponentUtils.resolveInteger(getProperty(CELL_SPACING_KEY));
}
/**
* Sets the spacing between cells.
*
* @param cellSpacing the new cellSpacing value
*/
final public void setCellSpacing(int cellSpacing)
{
setProperty(CELL_SPACING_KEY, Integer.valueOf(cellSpacing));
}
/**
* Gets the spacing within cells.
*
* @return the new cellPadding value
*/
final public int getCellPadding()
{
return ComponentUtils.resolveInteger(getProperty(CELL_PADDING_KEY));
}
/**
* Sets the spacing within cells.
*
* @param cellPadding the new cellPadding value
*/
final public void setCellPadding(int cellPadding)
{
setProperty(CELL_PADDING_KEY, Integer.valueOf(cellPadding));
}
/**
* Gets the border width around each cell.
*
* @return the new borderWidth value
*/
final public int getBorderWidth()
{
return ComponentUtils.resolveInteger(getProperty(BORDER_WIDTH_KEY));
}
/**
* Sets the border width around each cell.
*
* @param borderWidth the new borderWidth value
*/
final public void setBorderWidth(int borderWidth)
{
setProperty(BORDER_WIDTH_KEY, Integer.valueOf(borderWidth));
}
/**
* Gets The summary of the table's purpose and structure
* for user agents rendering to non-visual media. This attribute
* must be set if this element is being used to implement a data
* table (instead of a layout table).
*
* @return the new summary value
*/
final public String getSummary()
{
return ComponentUtils.resolveString(getProperty(SUMMARY_KEY));
}
/**
* Sets The summary of the table's purpose and structure
* for user agents rendering to non-visual media. This attribute
* must be set if this element is being used to implement a data
* table (instead of a layout table).
*
* @param summary the new summary value
*/
final public void setSummary(String summary)
{
setProperty(SUMMARY_KEY, (summary));
}
/**
* Gets the short description of the bean. This text
* is commonly used by user agents to display tooltip help text.
*
* @return the new shortDesc value
*/
final public String getShortDesc()
{
return ComponentUtils.resolveString(getProperty(SHORT_DESC_KEY));
}
/**
* Sets the short description of the bean. This text
* is commonly used by user agents to display tooltip help text.
*
* @param shortDesc the new shortDesc value
*/
final public void setShortDesc(String shortDesc)
{
setProperty(SHORT_DESC_KEY, (shortDesc));
}
/**
* Gets the IDs of the components that should trigger a partial update.
* 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.
*
* @return the new partialTriggers value
*/
final public String[] getPartialTriggers()
{
return (String[])getProperty(PARTIAL_TRIGGERS_KEY);
}
/**
* Sets the IDs of the components that should trigger a partial update.
* 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.
*
* @param partialTriggers the new partialTriggers value
*/
final public void setPartialTriggers(String[] partialTriggers)
{
setProperty(PARTIAL_TRIGGERS_KEY, (partialTriggers));
}
/**
* Gets an onclick Javascript handler.
*
* @return the new onclick value
*/
final public String getOnclick()
{
return ComponentUtils.resolveString(getProperty(ONCLICK_KEY));
}
/**
* Sets an onclick Javascript handler.
*
* @param onclick the new onclick value
*/
final public void setOnclick(String onclick)
{
setProperty(ONCLICK_KEY, (onclick));
}
/**
* Gets an ondblclick Javascript handler.
*
* @return the new ondblclick value
*/
final public String getOndblclick()
{
return ComponentUtils.resolveString(getProperty(ONDBLCLICK_KEY));
}
/**
* Sets an ondblclick Javascript handler.
*
* @param ondblclick the new ondblclick value
*/
final public void setOndblclick(String ondblclick)
{
setProperty(ONDBLCLICK_KEY, (ondblclick));
}
/**
* Gets an onmousedown Javascript handler.
*
* @return the new onmousedown value
*/
final public String getOnmousedown()
{
return ComponentUtils.resolveString(getProperty(ONMOUSEDOWN_KEY));
}
/**
* Sets an onmousedown Javascript handler.
*
* @param onmousedown the new onmousedown value
*/
final public void setOnmousedown(String onmousedown)
{
setProperty(ONMOUSEDOWN_KEY, (onmousedown));
}
/**
* Gets an onmouseup Javascript handler.
*
* @return the new onmouseup value
*/
final public String getOnmouseup()
{
return ComponentUtils.resolveString(getProperty(ONMOUSEUP_KEY));
}
/**
* Sets an onmouseup Javascript handler.
*
* @param onmouseup the new onmouseup value
*/
final public void setOnmouseup(String onmouseup)
{
setProperty(ONMOUSEUP_KEY, (onmouseup));
}
/**
* Gets an onmouseover Javascript handler.
*
* @return the new onmouseover value
*/
final public String getOnmouseover()
{
return ComponentUtils.resolveString(getProperty(ONMOUSEOVER_KEY));
}
/**
* Sets an onmouseover Javascript handler.
*
* @param onmouseover the new onmouseover value
*/
final public void setOnmouseover(String onmouseover)
{
setProperty(ONMOUSEOVER_KEY, (onmouseover));
}
/**
* Gets an onmousemove Javascript handler.
*
* @return the new onmousemove value
*/
final public String getOnmousemove()
{
return ComponentUtils.resolveString(getProperty(ONMOUSEMOVE_KEY));
}
/**
* Sets an onmousemove Javascript handler.
*
* @param onmousemove the new onmousemove value
*/
final public void setOnmousemove(String onmousemove)
{
setProperty(ONMOUSEMOVE_KEY, (onmousemove));
}
/**
* Gets an onmouseout Javascript handler.
*
* @return the new onmouseout value
*/
final public String getOnmouseout()
{
return ComponentUtils.resolveString(getProperty(ONMOUSEOUT_KEY));
}
/**
* Sets an onmouseout Javascript handler.
*
* @param onmouseout the new onmouseout value
*/
final public void setOnmouseout(String onmouseout)
{
setProperty(ONMOUSEOUT_KEY, (onmouseout));
}
/**
* Gets an onkeypress Javascript handler.
*
* @return the new onkeypress value
*/
final public String getOnkeypress()
{
return ComponentUtils.resolveString(getProperty(ONKEYPRESS_KEY));
}
/**
* Sets an onkeypress Javascript handler.
*
* @param onkeypress the new onkeypress value
*/
final public void setOnkeypress(String onkeypress)
{
setProperty(ONKEYPRESS_KEY, (onkeypress));
}
/**
* Gets an onkeydown Javascript handler.
*
* @return the new onkeydown value
*/
final public String getOnkeydown()
{
return ComponentUtils.resolveString(getProperty(ONKEYDOWN_KEY));
}
/**
* Sets an onkeydown Javascript handler.
*
* @param onkeydown the new onkeydown value
*/
final public void setOnkeydown(String onkeydown)
{
setProperty(ONKEYDOWN_KEY, (onkeydown));
}
/**
* Gets an onkeyup Javascript handler.
*
* @return the new onkeyup value
*/
final public String getOnkeyup()
{
return ComponentUtils.resolveString(getProperty(ONKEYUP_KEY));
}
/**
* Sets an onkeyup Javascript handler.
*
* @param onkeyup the new onkeyup value
*/
final public void setOnkeyup(String onkeyup)
{
setProperty(ONKEYUP_KEY, (onkeyup));
}
/**
* Gets the CSS style class of the bean.
*
* @return the new styleClass value
*/
final public String getStyleClass()
{
return ComponentUtils.resolveString(getProperty(STYLE_CLASS_KEY));
}
/**
* Sets the CSS style class of the bean.
*
* @param styleClass the new styleClass value
*/
final public void setStyleClass(String styleClass)
{
setProperty(STYLE_CLASS_KEY, (styleClass));
}
/**
* Gets the inline CSS style for this element
*
* @return the new inlineStyle value
*/
final public String getInlineStyle()
{
return ComponentUtils.resolveString(getProperty(INLINE_STYLE_KEY));
}
/**
* Sets the inline CSS style for this element
*
* @param inlineStyle the new inlineStyle value
*/
final public void setInlineStyle(String inlineStyle)
{
setProperty(INLINE_STYLE_KEY, (inlineStyle));
}
@Override
public String getDefaultEventName()
{
return "click";
}
@Override
public Collection getEventNames()
{
return _EVENT_NAMES;
}
@Override
public Map> getClientBehaviors()
{
return super.getClientBehaviors();
}
@Override
public void addClientBehavior(
String eventName,
ClientBehavior behavior)
{
super.addClientBehavior(eventName, behavior);
}
@Override
public String getFamily()
{
return COMPONENT_FAMILY;
}
@Override
protected FacesBean.Type getBeanType()
{
return TYPE;
}
/**
* Construct an instance of the HtmlTableLayout.
*/
protected HtmlTableLayout(
String rendererType
)
{
super(rendererType);
}
static
{
TYPE.lockAndRegister("org.apache.myfaces.trinidad.TableLayout","org.apache.myfaces.trinidad.TableLayout");
}
}