public class Lane extends RefDataClass
Timeline view, or in a day view when showDayLanes is true. Each lane is a row or column,
respectively, that can contain a set of CalendarEvents. CalendarEvents are
placed in lanes by matching the name property to the value of
the Calendar.laneNameField property on the
CalendarEvent. Lanes are typically used to show tasks assigned to different people, broadcasts planned for different channels, and similar displays.
idfactoryCreated, factoryProperties| Constructor and Description |
|---|
Lane() |
Lane(com.google.gwt.core.client.JavaScriptObject jsObj) |
Lane(java.lang.String name,
java.lang.String title) |
| Modifier and Type | Method and Description |
|---|---|
java.lang.String |
getEventStyleName()
The base name for the CSS class applied to
events
when they're rendered in this lane. |
java.lang.String |
getFieldStyleName()
The base style-name for
lane-fields displayed in
this Lane. |
java.lang.Integer |
getHeight()
In
Timelines, the height of this Lane's row. |
java.lang.String |
getName()
To determine whether a CalendarEvent should be placed in this lane, the value of this attribute is compared with the
Calendar.laneNameField property on the
CalendarEvent. |
static Lane |
getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj) |
java.lang.String |
getStyleName()
The base style-name for normal cells in this Lane.
|
Lane[] |
getSublanes()
|
java.lang.String |
getTitle()
Title to show for this lane.
|
java.lang.Integer |
getWidth()
When set on a Lane being displayed in a
day view as a
result of Calendar.showDayLanes being set,
dictates the width of the Lane's column. |
Lane |
setEventStyleName(java.lang.String eventStyleName)
The base name for the CSS class applied to
events
when they're rendered in this lane. |
Lane |
setFieldStyleName(java.lang.String fieldStyleName)
The base style-name for
lane-fields displayed in
this Lane. |
Lane |
setHeight(java.lang.Integer height)
In
Timelines, the height of this Lane's row. |
Lane |
setName(java.lang.String name)
To determine whether a CalendarEvent should be placed in this lane, the value of this attribute is compared with the
Calendar.laneNameField property on the
CalendarEvent. |
Lane |
setStyleName(java.lang.String styleName)
The base style-name for normal cells in this Lane.
|
Lane |
setSublanes(Lane... sublanes)
|
Lane |
setTitle(java.lang.String title)
Title to show for this lane.
|
Lane |
setWidth(java.lang.Integer width)
When set on a Lane being displayed in a
day view as a
result of Calendar.showDayLanes being set,
dictates the width of the Lane's column. |
getRef, getRef, internalSetIDapplyFactoryProperties, doAddHandler, fireEvent, getAttribute, getAttributeAsBoolean, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsDoubleArray, getAttributeAsFloat, getAttributeAsInt, getAttributeAsIntArray, getAttributeAsJavaScriptObject, getAttributeAsLong, getAttributeAsMap, getAttributeAsObject, getAttributeAsRecord, getAttributeAsString, getAttributeAsStringArray, getAttributes, getHandlerCount, isFactoryCreated, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttributeAsJavaObject, setFactoryCreatedpublic Lane()
public Lane(com.google.gwt.core.client.JavaScriptObject jsObj)
public Lane(java.lang.String name,
java.lang.String title)
public static Lane getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
public Lane setEventStyleName(java.lang.String eventStyleName)
events
when they're rendered in this lane. See Calendar.eventStyleName. If set directly on a sublane, overrides the corresponding value on the parent lane. See getEventCanvasStyle() for more
information.
eventStyleName - New eventStyleName value. Default value is nullLane instance, for chaining setter callsCSSStyleName,
Appearance overview and related methodspublic java.lang.String getEventStyleName()
events
when they're rendered in this lane. See Calendar.eventStyleName. If set directly on a sublane, overrides the corresponding value on the parent lane. See getEventCanvasStyle() for more
information.
CSSStyleName,
Appearance overview and related methodspublic Lane setFieldStyleName(java.lang.String fieldStyleName)
lane-fields displayed in
this Lane.fieldStyleName - New fieldStyleName value. Default value is nullLane instance, for chaining setter callsCSSStyleName,
Appearance overview and related methodspublic java.lang.String getFieldStyleName()
lane-fields displayed in
this Lane.CSSStyleName,
Appearance overview and related methodspublic Lane setHeight(java.lang.Integer height)
Timelines, the height of this Lane's row. Has no effect when set on a
Lane being displayed in a day view as a result of
Calendar.showDayLanes being true. If set
directly on a sublane, overrides the default behavior of
dividing the height equally among the lane's sublanes. Each sublane is still initially assigned an equal slice of the
parent height, and the value for this sublane is then updated. So the overall height of the parent lane will change by
the delta between the initial slice and the specified one.
height - New height value. Default value is nullLane instance, for chaining setter callspublic java.lang.Integer getHeight()
Timelines, the height of this Lane's row. Has no effect when set on a
Lane being displayed in a day view as a result of
Calendar.showDayLanes being true. If set
directly on a sublane, overrides the default behavior of
dividing the height equally among the lane's sublanes. Each sublane is still initially assigned an equal slice of the
parent height, and the value for this sublane is then updated. So the overall height of the parent lane will change by
the delta between the initial slice and the specified one.
public Lane setName(java.lang.String name)
Calendar.laneNameField property on the
CalendarEvent.name - New name value. Default value is nullLane instance, for chaining setter callspublic java.lang.String getName()
Calendar.laneNameField property on the
CalendarEvent.public Lane setStyleName(java.lang.String styleName)
styleName - New styleName value. Default value is nullLane instance, for chaining setter callsCSSStyleName,
Appearance overview and related methodspublic java.lang.String getStyleName()
CSSStyleName,
Appearance overview and related methodspublic Lane setSublanes(Lane... sublanes)
Lane objects that will share the available space in the parent
Lane, vertically in timelines and horizontally in
day views. Only one level of sublanes is supported,
so this attribute only has an effect on top-level lanes.
Note that this feature is mutually exclusive with the auto arrangement of events that share time.
sublanes - New sublanes value. Default value is nullLane instance, for chaining setter callspublic Lane[] getSublanes()
Lane objects that will share the available space in the parent
Lane, vertically in timelines and horizontally in
day views. Only one level of sublanes is supported,
so this attribute only has an effect on top-level lanes.
Note that this feature is mutually exclusive with the auto arrangement of events that share time.
public Lane setTitle(java.lang.String title)
sublanes.title - New title value. Default value is nullLane instance, for chaining setter callsHTMLStringpublic java.lang.String getTitle()
sublanes.HTMLStringpublic Lane setWidth(java.lang.Integer width)
day view as a
result of Calendar.showDayLanes being set,
dictates the width of the Lane's column. Has no effect in Timelines.
If set directly on a sublane, overrides the default
behavior of dividing the width equally among the lane's sublanes. Each sublane is still initially assigned an equal
slice of the original parent width, and the value for this sublane is then updated. So the overall width of the parent
lane will change by the delta between the initial slice and the specified one.
width - New width value. Default value is nullLane instance, for chaining setter callspublic java.lang.Integer getWidth()
day view as a
result of Calendar.showDayLanes being set,
dictates the width of the Lane's column. Has no effect in Timelines.
If set directly on a sublane, overrides the default
behavior of dividing the width equally among the lane's sublanes. Each sublane is still initially assigned an equal
slice of the original parent width, and the value for this sublane is then updated. So the overall width of the parent
lane will change by the delta between the initial slice and the specified one.