Interface IFisheyebar
-
- All Superinterfaces:
IAnyGroup<IFisheyebar>
,IChildable<IFisheyebar,IFisheye>
,IComponent<IFisheyebar>
,IHtmlBasedComponent<IFisheyebar>
,IXulElement<IFisheyebar>
public interface IFisheyebar extends IXulElement<IFisheyebar>, IAnyGroup<IFisheyebar>, IChildable<IFisheyebar,IFisheye>
ImmutableFisheyebar
component- Author:
- jumperchen
- See Also:
Fisheyebar
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
IFisheyebar.Builder
Builds instances of typeIFisheyebar
.static class
IFisheyebar.Edge
Specifies the attach edge ofIFisheyebar
componentstatic class
IFisheyebar.Orient
Specifies the orient ofIFisheyebar
componentstatic class
IFisheyebar.Updater
Builds an updater of typeIFisheyebar
forUiAgent.smartUpdate(Locator, SmartUpdater)
.
-
Field Summary
Fields Modifier and Type Field Description static IFisheyebar
DEFAULT
Constant for default attributes of this immutable component.
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default java.lang.String
getAttachEdge()
Returns the attach edge.default int
getItemHeight()
Returns the item height ofIFisheye
.default int
getItemMaxHeight()
Returns the item maximal height ofIFisheye
.default int
getItemMaxWidth()
Returns the item maximal width ofIFisheye
.default int
getItemPadding()
Returns the item padding ofIFisheye
.default int
getItemWidth()
Returns the item width ofIFisheye
.default java.lang.String
getLabelEdge()
Returns the label edge.default java.lang.String
getOrient()
Returns the orient.default java.lang.String
getWidgetClass()
Returns the client widget class.static IFisheyebar
of(java.lang.Iterable<? extends IFisheye> children)
Returns the instance with the givenIFisheye
children.static IFisheyebar
of(IFisheye... children)
Returns the instance with the givenIFisheye
children.static IFisheyebar
ofId(java.lang.String id)
Returns the instance with the given id.IFisheyebar
withAttachEdge(java.lang.String attachEdge)
Returns a copy ofthis
immutable component with the specifiedattachEdge
.default IFisheyebar
withAttachEdge(IFisheyebar.Edge attachEdge)
Returns a copy ofthis
immutable component with the specifiedattachEdge
.IFisheyebar
withItemHeight(int itemHeight)
Returns a copy ofthis
immutable component with the specifieditemHeight
.IFisheyebar
withItemMaxHeight(int itemMaxHeight)
Returns a copy ofthis
immutable component with the specifieditemMaxHeight
.IFisheyebar
withItemMaxWidth(int itemMaxWidth)
Returns a copy ofthis
immutable component with the specifieditemMaxWidth
.IFisheyebar
withItemPadding(int itemPadding)
Returns a copy ofthis
immutable component with the specifieditemPadding
.IFisheyebar
withItemWidth(int itemWidth)
Returns a copy ofthis
immutable component with the specifieditemWidth
.IFisheyebar
withLabelEdge(java.lang.String labelEdge)
Returns a copy ofthis
immutable component with the specifiedlabelEdge
.default IFisheyebar
withLabelEdge(IFisheyebar.Edge labelEdge)
Returns a copy ofthis
immutable component with the specifiedlabelEdge
.IFisheyebar
withOrient(java.lang.String orient)
Returns a copy ofthis
immutable component with the specifiedorient
.default IFisheyebar
withOrient(IFisheyebar.Orient orient)
Returns a copy ofthis
immutable component with the specifiedorient
.-
Methods inherited from interface org.zkoss.stateless.sul.IChildable
getChildren, withChildren, withChildren
-
Methods inherited from interface org.zkoss.stateless.sul.IComponent
getAction, getActions, getClientAttributes, getId, getMold, getWidgetListeners, getWidgetOverrides, isVisible, withAction, withAction, withAction, withAction, withAction, withAction, withAction, withAction, withAction, withAction, withAction, withActions, withActions, withClientAttribute, withClientAttributes, withId, withMold, withVisible, withWidgetClass, withWidgetListener, withWidgetListeners, withWidgetOverride, withWidgetOverrides
-
Methods inherited from interface org.zkoss.stateless.sul.IHtmlBasedComponent
getClientAction, getDraggable, getDroppable, getHeight, getHflex, getLeft, getRenderdefer, getSclass, getStyle, getTabindex, getTooltiptext, getTop, getVflex, getWidth, getZclass, getZIndex, isFocus, withClientAction, withDraggable, withDroppable, withFocus, withHeight, withHflex, withLeft, withRenderdefer, withSclass, withStyle, withTabindex, withTabindex, withTooltiptext, withTop, withVflex, withWidth, withZclass, withZIndex
-
Methods inherited from interface org.zkoss.stateless.sul.IXulElement
getContext, getCtrlKeys, getPopup, getTooltip, withContext, withCtrlKeys, withPopup, withTooltip
-
-
-
-
Field Detail
-
DEFAULT
static final IFisheyebar DEFAULT
Constant for default attributes of this immutable component.
-
-
Method Detail
-
getWidgetClass
default java.lang.String getWidgetClass()
Returns the client widget class.Default:
"zkex.menu.Fisheyebar"
- Specified by:
getWidgetClass
in interfaceIComponent<IFisheyebar>
-
getOrient
default java.lang.String getOrient()
Returns the orient.Default:
"horizontal"
.
-
withOrient
IFisheyebar withOrient(java.lang.String orient)
Returns a copy ofthis
immutable component with the specifiedorient
.Sets the orient of component
- Parameters:
orient
- Either"horizontal"
or"vertical"
Default:
"horizontal"
.- Returns:
- A modified copy of the
this
object
-
withOrient
default IFisheyebar withOrient(IFisheyebar.Orient orient)
Returns a copy ofthis
immutable component with the specifiedorient
.Sets the orient of component
- Parameters:
orient
- Theorient
Default:
"horizontal"
.- Returns:
- A modified copy of the
this
object
-
getAttachEdge
default java.lang.String getAttachEdge()
Returns the attach edge.Default:
center
-
withAttachEdge
IFisheyebar withAttachEdge(java.lang.String attachEdge)
Returns a copy ofthis
immutable component with the specifiedattachEdge
.Sets the attach edge. It will decide the direction to zoom the image if fisheye. Allowed values:
"center", "top", "bottom", "left", "right"
Note that
"left","right"
apply for getOrient() is"vertical"
- Parameters:
attachEdge
- The attach edge ofIFisheyebar
Default:
center
.- Returns:
- A modified copy of the
this
object
-
withAttachEdge
default IFisheyebar withAttachEdge(IFisheyebar.Edge attachEdge)
Returns a copy ofthis
immutable component with the specifiedattachEdge
.Sets the attach edge. It will decide the direction to zoom the image if fisheye. Allowed values:
"center", "top", "bottom", "left", "right"
Note that
"left","right"
apply for getOrient() is"vertical"
- Parameters:
attachEdge
- TheIFisheyebar.Edge
Default:
center
.- Returns:
- A modified copy of the
this
object
-
getLabelEdge
default java.lang.String getLabelEdge()
Returns the label edge.Default:
bottom
-
withLabelEdge
IFisheyebar withLabelEdge(java.lang.String labelEdge)
Returns a copy ofthis
immutable component with the specifiedlabelEdge
.Sets the label edge. Decides the direction to show the label of fisheye. Allowed values:
"center", "top", "bottom", "left", "right"
Note that
"left","right"
apply for getOrient() is"vertical"
- Parameters:
labelEdge
- The label edge ofIFisheyebar
Default:
bottom
.- Returns:
- A modified copy of the
this
object
-
withLabelEdge
default IFisheyebar withLabelEdge(IFisheyebar.Edge labelEdge)
Returns a copy ofthis
immutable component with the specifiedlabelEdge
.Sets the label edge. Decides the direction to show the label of fisheye. Allowed values:
"center", "top", "bottom", "left", "right"
Note that
"left","right"
apply for getOrient() is"vertical"
- Parameters:
labelEdge
- TheIFisheyebar.Edge
Default:
bottom
.- Returns:
- A modified copy of the
this
object
-
getItemWidth
default int getItemWidth()
Returns the item width ofIFisheye
.Default:
50
.
-
withItemWidth
IFisheyebar withItemWidth(int itemWidth)
Returns a copy ofthis
immutable component with the specifieditemWidth
.Sets the item width of
IFisheye
.- Parameters:
itemWidth
- The width ofIFisheye
Default:
50
.- Returns:
- A modified copy of the
this
object
-
getItemHeight
default int getItemHeight()
Returns the item height ofIFisheye
.Default:
50
.
-
withItemHeight
IFisheyebar withItemHeight(int itemHeight)
Returns a copy ofthis
immutable component with the specifieditemHeight
.Sets the item height of
IFisheye
.- Parameters:
itemHeight
- The height ofIFisheye
Default:
50
.- Returns:
- A modified copy of the
this
object
-
getItemMaxWidth
default int getItemMaxWidth()
Returns the item maximal width ofIFisheye
.Default:
200
.
-
withItemMaxWidth
IFisheyebar withItemMaxWidth(int itemMaxWidth)
Returns a copy ofthis
immutable component with the specifieditemMaxWidth
.Sets the item maximal width of
IFisheye
.- Parameters:
itemMaxWidth
- The maximal width ofIFisheye
Default:
200
.- Returns:
- A modified copy of the
this
object
-
getItemMaxHeight
default int getItemMaxHeight()
Returns the item maximal height ofIFisheye
.Default:
200
.
-
withItemMaxHeight
IFisheyebar withItemMaxHeight(int itemMaxHeight)
Returns a copy ofthis
immutable component with the specifieditemMaxHeight
.Sets the item maximal height of
IFisheye
.- Parameters:
itemMaxHeight
- The maximal height ofIFisheye
Default:
200
.- Returns:
- A modified copy of the
this
object
-
getItemPadding
default int getItemPadding()
Returns the item padding ofIFisheye
.Default:
10
.
-
withItemPadding
IFisheyebar withItemPadding(int itemPadding)
Returns a copy ofthis
immutable component with the specifieditemPadding
.Sets the item padding of
IFisheye
.- Parameters:
itemPadding
- The padding ofIFisheye
Default:
10
.- Returns:
- A modified copy of the
this
object
-
of
static IFisheyebar of(java.lang.Iterable<? extends IFisheye> children)
Returns the instance with the givenIFisheye
children.- Parameters:
children
- The children ofIFisheye
-
of
static IFisheyebar of(IFisheye... children)
Returns the instance with the givenIFisheye
children.- Parameters:
children
- The children ofIFisheye
-
ofId
static IFisheyebar ofId(java.lang.String id)
Returns the instance with the given id.- Parameters:
id
- The id to identify this component
-
-