com.jivesoftware.community.widget
Class WidgetFrame

java.lang.Object
  com.jivesoftware.community.widget.WidgetFrame

public class WidgetFrame
extends Object

Constructor Summary

WidgetFrame()

Method Summary

int	getContainerID() Gets the id of the container
long	getID() Gets the id of the WidgetFrame
int	getIndex() Gets the index of this WidgetFrame in the specified container, the index is zero based.
JiveObject	getParentObject() Gets the parent JiveObject of this frame
String	getValidationMessage() Returns a possible validation message or null if there is none
Widget	getWidget() Gets the Widget for this frame
boolean	isValidatable() Let's the templates know if they can check for validation messages that might need to be displayed.
void	setContainerID(int containerID) Sets the id of the container.
void	setID(long ID) Sets the id of the WidgetFrame
void	setIndex(int index) Sets the index of this WidgetFrame in the specified container, the index is zero based.
void	setParentObject(JiveObject parentObject) Sets the parent JiveObject of this frame
void	setWidget(Widget widget) Sets the Widget for this frame

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WidgetFrame

public WidgetFrame()

Method Detail

getID

public long getID()

Gets the id of the WidgetFrame

Returns:

the id of the WidgetFrame

setID

public void setID(long ID)

Sets the id of the WidgetFrame

Parameters:

ID - the id of the WidgetFrame

getWidget

public Widget getWidget()

Gets the Widget for this frame

Returns:

the Widget for this frame

setWidget

public void setWidget(Widget widget)

Sets the Widget for this frame

Parameters:

widget - the Widget for this frame

getParentObject

public JiveObject getParentObject()

Gets the parent JiveObject of this frame

Returns:

the parent JiveObject of this frame

setParentObject

public void setParentObject(JiveObject parentObject)

Sets the parent JiveObject of this frame

Parameters:

parentObject - the parent JiveObject of this frame

getContainerID

public int getContainerID()

Gets the id of the container

Returns:

the id of the container

setContainerID

public void setContainerID(int containerID)

Sets the id of the container. The container ID starts at one.

Parameters:

containerID - the id of the container

getIndex

public int getIndex()

Gets the index of this WidgetFrame in the specified container, the index is zero based.

Returns:

the index of this WidgetFrame in the specified container.

setIndex

public void setIndex(int index)

Sets the index of this WidgetFrame in the specified container, the index is zero based.

Parameters:

index - the index of this WidgetFrame in the specified container.

isValidatable

public boolean isValidatable()

Let's the templates know if they can check for validation messages that might need to be displayed.

Returns:

getValidationMessage

public String getValidationMessage()

Returns a possible validation message or null if there is none